KYC

Reset an investor's KYC

POST/kyc-checks/{id}/actions/reset

Resets the Sumsub applicant when one exists, soft-deletes every stored check result, keeps the check level, and returns the check. Sumsub errors return 502, an unreachable Sumsub 503, and nothing is deleted. dry_run only validates and resolves. Emits kyc_check.reset once, only when an applicant was reset or a row cleared. Takes no body: any key is 422 validation_failed. No email or notification. It can't be undone.

Path parameters

  • idstring (uuid)Required#

    The investor's id.

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.

Responses

200

The investor's KYC check after the reset.

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