KYC

Get a Sumsub document image

GET/kyc/checks/{transactionUserId}/documents/{inspectionId}/{imageId}
kyc:readget_kyc_document_imageRead-onlyDeprecatedSunset 2027-06-30

Streams a Sumsub document image (binary blob) for a transaction user's inspection. The id is resolved org-scoped → a cross-org / unknown id 404s leak-safely before any outbound call; a Sumsub failure (unknown inspection/image) is surfaced as a leak-safe 404; an unreachable Sumsub is 503. Deprecated: withdrawn on 2027-06-30. GET /kyc-checks/{kyc_check_id}/documents/{id} replaces it, keyed by the investor id with inspection_id as a query parameter; every answer carries a Link header with rel="successor-version".

Path parameters

  • transactionUserIdstring (uuid)Required#

    The deals-service transaction user id.

  • inspectionIdstringRequired#

    The Sumsub inspection id.

  • imageIdstringRequired#

    The Sumsub document image id.

Responses

200

The document image blob.

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}/documents/{inspectionId}/{imageId}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"