Initiate Core v2 sign-in

POST

/api/v2/auth/login

curl --request POST \
  --url https://core.example.com/api/v2/auth/login \
  --header 'Content-Type: application/json' \
  --header 'app-token: <app-token>' \
  --data '{ "email": "hello@example.com", "password": "example", "private_key": "example", "locale": "en", "banking_api": false, "method": "example", "pin": "example", "chinese_checkout": true, "api_request": true }'

• Replace with the Core URL for the target environment

Authorizations

• AppToken

Request Body^required

Media typeapplication/json

object

email

required

string format: email

password

string format: password

private_key

string

nullable

locale

string

default: en

banking_api

boolean

method

string

nullable

pin

string

nullable

chinese_checkout

boolean

nullable

api_request

boolean

nullable

Responses

200

Session created; the confirmation method is provided in method

Media typeapplication/json

object

success

required

boolean

status

required

integer

session_token

string

session

string

expiration

string

wallet_type

string

current_currency

string

country

string

method

string

user_id

integer

Example

{
  "success": true,
  "status": 200
}

403

Authorization, validation, or business-rule error

Media typeapplication/json

object

success

required

boolean

status

required

integer

errors

required

One of:

Array<object>

Array<object>

object

code

string

kind

string

nullable

expiration

string

nullable

session

string

nullable

key

additional properties

any

object

object

key

additional properties

any

string

string

key

additional properties

any

Example

{
  "success": false,
  "status": 403
}

422

User not found for an api_request

Media typeapplication/json

object

success

required

boolean

status

required

integer

errors

required

One of:

Array<object>

Array<object>

object

code

string

kind

string

nullable

expiration

string

nullable

session

string

nullable

key

additional properties

any

object

object

key

additional properties

any

string

string

key

additional properties

any

Example

{
  "success": false,
  "status": 403
}