Get a document

get/documents/{id}

Returns a document.

Endpoint destination URL

https://kyc-test.adyen.com/lem/v3/documents/{id}

Query Parameters

Required

Optional

Do not load document content while fetching the document.

Path Parameters

Required

Optional

The unique identifier of the document.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
Show moreShow less
attachmentobjectDeprecated in version 1
Use the attachments array instead.
Object that contains the document.
Show children Hide children
contentstring
The document in Base64-encoded string format.
contentTypestringDeprecated in version 1
The file format.

Possible values: application/pdf, image/jpg, image/jpeg, image/png.
filenamestringDeprecated in version 1
The name of the file including the file extension.
pageNamestring
The name of the file including the file extension.
pageTypestring
Specifies which side of the ID card is uploaded.

When type is driversLicense or identityCard, set this to front or back.

When omitted, we infer the page number based on the order of attachments.

attachmentsarray[object]
Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.
Show children Hide children
contentstring
The document in Base64-encoded string format.
contentTypestringDeprecated in version 1
The file format.

Possible values: application/pdf, image/jpg, image/jpeg, image/png.
filenamestringDeprecated in version 1
The name of the file including the file extension.
pageNamestring
The name of the file including the file extension.
pageTypestring
Specifies which side of the ID card is uploaded.

When type is driversLicense or identityCard, set this to front or back.

When omitted, we infer the page number based on the order of attachments.

creationDatestring
The creation date of the document.
descriptionstring
Your description for the document.
expiryDatestringDeprecated in version 1
The expiry date of the document, in YYYY-MM-DD format.
fileNamestring
The filename of the document.
idstring
The unique identifier of the document.
issuerCountrystringDeprecated in version 1
The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US.
issuerStatestringDeprecated in version 1
The state or province where the document was issued (AU only).
modificationDatestring
The modification date of the document.
numberstring
The number in the document.
ownerobject
Contains information about the resource that owns the document.
Show children Hide children
idstring
Unique identifier of the resource that owns the document. For type legalEntity, this value is the unique identifier of the legal entity. For type bankAccount, this value is the unique identifier of the transfer instrument.
typestring
Type of resource that owns the document.

Possible values: legalEntity, bankAccount.
typestring
Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.

For organization, the type values can be proofOfAddress, registrationDocument, vatDocument, proofOfOrganizationTaxInfo, proofOfOwnership, proofOfIndustry, proofOfSignatory, or proofOfFundingOrWealthSource.

For individual, the type values can be identityCard, driversLicense, passport, liveSelfie, proofOfNationalIdNumber, proofOfResidency, proofOfIndustry, proofOfIndividualTaxId, proofOfFundingOrWealthSource or proofOfRelationship.

For soleProprietorship, the type values can be constitutionalDocument, proofOfAddress, or proofOfIndustry.

For trust, the type value is constitutionalDocument.

For unincorporatedPartnership, the type value is constitutionalDocument.

Use bankStatement to upload documents for a transfer instrument.
400 - Bad Request
A problem reading or understanding the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Get a document

Query Parameters

Path Parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error