Initiate the KYC process

POST

/api/v1/kyc/apply

const url = 'https://core.example.com/api/v1/kyc/apply';
const options = {method: 'POST', headers: {'session-token': '<session-token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://core.example.com/api/v1/kyc/apply \
  --header 'session-token: <session-token>'

Authorizations

SessionToken

Responses

200

KYC provider parameters

application/json

object

success

required

boolean

status

required

integer

kyc_params

object

type

string

path

string

client_id

string

external_user_id

string

access_token

string

Example

{
  "success": true,
  "status": 200,
  "kyc_params": {
    "type": "sumsub"
  }
}

403

Authorization, validation, or business-rule error

application/json

object

success

required

boolean

status

required

integer

errors

required

One of:

Array<object>

object

code

string

kind

string

nullable

expiration

string

nullable

session

string

nullable

key

additional properties

any

key

additional properties

any

Example

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