KYC

Mint a Sumsub access token

POST/kyc/access-tokens
kyc:writemint_kyc_access_tokenDeprecatedSunset 2027-06-30

Mints a Sumsub SDK access token for a user and level. Identify the user by EITHER transactionUserId OR userId (the user guid). levelName defaults to the stored check level; with neither, 422. An unknown or cross-org id is 404, a Sumsub failure 502, an unreachable Sumsub 503. A levelName you send is stored as the user's check level once the token is minted. Deprecated: withdrawn on 2027-06-30. POST /kyc-checks/{id}/actions/issue-access-token replaces it, keyed by the investor id; every answer carries a Link header with rel="successor-version".

Request body

application/json, required

  • transactionUserIdstring#

    The deals-service transaction user id (one of transactionUserId / userId).

  • userIdstring#

    The user guid (one of transactionUserId / userId).

  • levelNamestring | null#

    The Sumsub level name (defaults to the user's stored level).

{
  "transactionUserId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "levelName": "basic-kyc-level"
}

Responses

200

OK

KycAccessTokenEnvelope
{
  "data": {
    "token": "_act-sbx-jwt-xxxxx",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "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

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

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/access-tokens\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "transactionUserId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "levelName": "basic-kyc-level"
}'