Get Document Info
/documents/{documentId}This endpoint provides dual functionality based on the Accept header:
- JSON Response: When no specific Accept header or
application/jsonis provided, this endpoint returns document metadata information. - File Download: When the Accept header matches one of the supported document formats (
application/pdf,image/jpeg, orimage/png), the endpoint returns the actual document file for download.
Only documents with category “transfer_purpose” can be downloaded, and the document’s mime type must match one of the supported formats.
Path Parameters
Response
OK
A reference to the document given by API caller
The ID of an individual or company who owns the document.
More categories will be added over time.
The type kyc_provider_result can be used to upload reports from the 3rd party KYC providers.
The type kyc_provider_result can be used to upload reports from the 3rd party KYC providers.
Time of expiry of the validity of this identity document.
Error defines errors may be returned from the system.
Error defines errors may be returned from the system.
Error defines errors may be returned from the system.