KYC

Get a user's Sumsub applicant status

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

Fetches the live Sumsub admin/applicant status for the transaction user (the transaction-user id is Sumsub's externalUserId) and normalises the review block into a stable domain shape. The id is resolved org-scoped → a cross-org / unknown id 404s leak-safely before any outbound call; a Sumsub 404 (no applicant) is also surfaced as 404; an unreachable Sumsub is 503. Deprecated: withdrawn on 2027-06-30. GET /kyc-checks/{id}/status 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

KycStatusEnvelope
{
  "data": {
    "transaction_user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "applicant_id": "5f6a7b8c9d0e4f1a8b2c3d4e",
    "review_status": "completed",
    "review_answer": "GREEN",
    "review_date": "2026-01-01 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
404

Resource not found (error.code = not_found).

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 https://your-org-domain/kong/core/api/v2/kyc/checks/{transactionUserId}/status\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"