KYC

Get an investor's live KYC review

GET/kyc-checks/{id}/status

Returns the live Sumsub review of the investor's applicant: applicant_id, review_status, review_answer and review_date. Reading it also tags the Sumsub applicant with this platform's tenant when it is not tagged yet, so it is not a pure read. A Sumsub 404 returns 404, other Sumsub errors 502, and an unreachable Sumsub 503 with Retry-After. Use GET /kyc-checks/{id} for the stored check.

Path parameters

  • idstring (uuid)Required#

    The investor's id.

Responses

200

The live review summary.

KycInvestorStatusEnvelope
{
  "data": {
    "id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
    "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/{id}/status\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"