Download Kyc Verification Document

Stream a stored verification document for a user.

Gated by the documents visibility group: a client whose config does not
grant it gets 403. Scoped to the caller's client; an unknown user, missing
record, missing file, or cross-tenant subject all return 404.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Download a stored identity-verification document for one of your individual customers. The endpoint locates the customer's most recent verification record under your client, finds the file matching the requested file_role, and streams it back as a binary attachment. The download is recorded in your client's audit log.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • The caller must hold the kyc.users.read permission and have the OWNER or OPERATIONS role.
  • Document download must be enabled for your client. If your client's verification visibility configuration does not grant the documents group, the request returns 403.

Path parameters

  • user_id — the individual customer whose document you want. Must belong to your client.
  • file_role — which document to download. Supported values for KYC:
    • kyc_id_front — front of the identity document
    • kyc_id_back — back of the identity document
    • kyc_selfie — selfie / liveness capture
    • kyc_poa — proof-of-address document
    • kyc_nfc_photo — photo read from the document chip

An unrecognized file_role is treated as a missing document (404).

Which record is used

The document is taken from the customer's most recent verification record (ordered by decision time, then fetch time). Records belonging to other clients are never returned, and a user_id that does not exist or has no verification record returns 404.

Response

200 OK returns the raw file as an attachment, not JSON:

  • The body is the binary file content.
  • Content-Type is the document's stored content type, falling back to application/octet-stream.
  • Content-Disposition is attachment with the document's original filename (sanitized).
  • X-Content-Type-Options: nosniff is set.

Error responses

StatusWhen
403Document download is not enabled for your client (the documents visibility group is not granted)
404Unrecognized file_role; no verification record for this user under your client; or no file of that role on the record

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.

Path Params
string
required
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json