KYC

Get a user's KYC check level

GET/kyc/checks/{transactionUserId}
kyc:readget_user_kyc_checkRead-onlyDeprecatedSunset 2027-06-30

Gets the transaction user's stored KYC check level (the locally-stored enrollment, distinct from the live Sumsub status). Replaces the legacy my-check-level read by an explicit transaction-user id; the id is resolved org-scoped → a cross-org / unknown id 404s leak-safely. Deprecated: withdrawn on 2027-06-30. GET /kyc-checks/{id} replaces it, keyed by the investor id; every answer carries a Link header with rel="successor-version".

Path parameters

  • transactionUserIdstring (uuid)Required#

    The deals-service transaction user id.

Responses

200

OK

KycCheck
{
  "data": {
    "transaction_user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "user_id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
    "kyc_check_level": "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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/kyc/checks/{transactionUserId}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"