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:
kycidmust come from the KYC submission response and must belong tocustomerid, which must be linked to yourclientid. A mismatch returns403; an id that does not exist returns500.
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
- 200
- 401
- 403
- 500
The KYC record, the fields held against it, and its document state.
MISSING_TOKEN when the X-ROMA-Signature header is absent, INVALID_TOKEN when it matches no active credential.
The customer is not linked to this clientid, the customer is unknown, or the KYC record does not belong to the customer.
The kycid does not exist, or the record could not be read. An unknown kycid is reported here rather than as 403 or 404.