KYC

Add a KYC level

POST/kyc-levels

Adds a Sumsub KYC check level and returns it with a Location. level_name is the Sumsub level identifier that access tokens are minted against. It is required and at most 255 characters; another level may already use it. label is optional and defaults to level_name. dry_run validates and shows the result without saving it. Emits kyc_level.created and sends no email. Delete the level with DELETE /kyc-levels/{id} to undo it.

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, required · KycLevelCreate

  • level_namestringRequired#

    The Sumsub level name. No other level may already use it.

  • labelstring | null#

    The display label. Defaults to level_name.

{
  "level_name": "basic-kyc-level",
  "label": "Basic KYC"
}

Responses

201

The level was added.

KycLevel
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "level_name": "basic-kyc-level",
    "label": "Basic KYC",
    "created_at": "2026-06-15T10:30:00+00:00",
    "updated_at": "2026-06-15T10:30:00+00:00"
  }
}
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
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

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/kyc-levels\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "level_name": "basic-kyc-level",
  "label": "Basic KYC"
}'