KYC

Get an investor's KYC check

GET/kyc-checks/{id}

Returns an investor's KYC check as stored on the platform: the check level they are enrolled in, and the status, detail and effective date of their latest live check result, each null when there is none. An unknown, invisible, external or malformed investor id, or an investor with no KYC record yet, returns 404. Use GET /kyc-checks/{id}/status for the live Sumsub review. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The investor's id.

Responses

200

The investor's KYC check.

KycInvestorCheck
{
  "data": {
    "id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
    "kyc_check_level": "basic-kyc-level",
    "kyc_status": "completed",
    "kyc_status_detail": "GREEN",
    "effective_date": "2026-01-02T03:04:05+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

Examples

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