KYC

Get an investor's KYC document image

GET/kyc-checks/{kyc_check_id}/documents/{id}
kyc:readget_kyc_check_documentRead-only

Returns one Sumsub document image of the investor's check as raw bytes, with Sumsub's Content-Type. inspection_id is required and must be the applicant's current inspection, else 404. A missing image returns 404, other Sumsub errors 502, and an unreachable Sumsub 503 with Retry-After. It changes nothing.

Path parameters

  • kyc_check_idstring (uuid)Required#

    The investor's id.

  • idstringRequired#

    The Sumsub document image id.

Query parameters

  • inspection_idstringRequired#

    The Sumsub inspection id the image belongs to. It must be the applicant's current inspection.

Responses

200

The document image bytes. The Content-Type is the one Sumsub sends (for example image/jpeg, image/png or application/pdf), passed through unchanged, and application/octet-stream when it sends none.

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