KYC

Issue a KYC access token for an investor

POST/kyc-checks/{id}/actions/issue-access-token
kyc:writeissue_access_token_kyc_check

Issues a Sumsub SDK token at level_name, which defaults to the stored check level; with neither, 422 invalid_request. A given level_name is stored as the check level once Sumsub issues the token. Other body keys (such as levelName) are 422 validation_failed. Idempotency-Key is ignored. Sumsub errors return 502, an unreachable Sumsub 503. dry_run validates only and returns token: null. No webhook or email. The token can't be recalled.

Path parameters

  • idstring (uuid)Required#

    The investor's id.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, optional

  • level_namestring | null#

    The Sumsub level name to issue the token for. Defaults to the investor's stored check level, and is stored as that level when given.

{
  "level_name": "basic-kyc-level"
}

Responses

200

The access token and the level it was issued for.

KycInvestorAccessTokenEnvelope
{
  "data": {
    "token": "_act-sbx-jwt-xxxxx",
    "level_name": "basic-kyc-level"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error
502

An upstream dependency (e.g. Sumsub) was unavailable (error.code = upstream_error).

Error
503

An upstream dependency (e.g. Sumsub) could not be reached or timed out (error.code = upstream_unavailable). Retry after the Retry-After delay.

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/kyc-checks/{id}/actions/issue-access-token\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "level_name": "basic-kyc-level"
}'