Skip to main content

Get KYC Details

GET 

/api/v2/client/:clientid/customer/:customerid/kyc/:kycid

Returns the KYC record for a customer: its current status, the field values held against it, the documents already on file, and the document types still outstanding.

Use this to reconcile a submission — for example, to show a customer what is left to upload before verification can proceed. For a status-only poll, use Get Customer KYC Status.

Requirements:

  • kycid must come from the KYC submission response and must belong to customerid, which must be linked to your clientid. A mismatch returns 403; an id that does not exist returns 500.

No file content is ever returned. submitted_documents[] carries metadata only, and the entries in details[] that hold a stored document reference come back redacted.

pending_documents[] is populated on the US flow only, where documents are uploaded separately through Submit KYC Documents. On the Standard flow documents are sent inline with the KYC submission, so the array is always empty. An empty array means nothing is known to be outstanding — it is not a confirmation that verification has finished. Read status for that.

Request

Responses

The KYC record, the fields held against it, and its document state.