Get documents

post/getUploadedDocuments

API Version

Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the verification process.

Endpoint destination URL

https://cal-test.adyen.com/cal/services/Account/v6/getUploadedDocuments

Request Parameters

Required

Optional

The code of the Account Holder for which to retrieve the documents.

The code of the Bank Account for which to retrieve the documents.

The code of the Shareholder for which to retrieve the documents.

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.
documentDetailsarray[object]
A list of the documents and their details.
accountHolderCodestring
The code of account holder, to which the document applies.
bankAccountUUIDstring
The Adyen-generated bankAccountUUID to which the document must be linked. Refer to Bank account check for details on when a document should be submitted.

Required if the documentType is BANK_STATEMENT, where a document is being submitted in order to verify a bank account.

descriptionstring
Description of the document.
documentTypestring
The type of the document. Refer to Verification checks for details on when each document type should be submitted and for the accepted file formats.

Permitted values:

BANK_STATEMENT: A file containing a bank statement or other document proving ownership of a specific bank account.

COMPANY_REGISTRATION_SCREENING (Supported from v5 and later): A file containing a company registration document.

CONSTITUTIONAL_DOCUMENT: A file containing information about the account holder's legal arrangement.

PASSPORT: A file containing the identity page(s) of a passport.

ID_CARD_FRONT: A file containing only the front of the ID card. In order for a document to be usable, both the ID_CARD_FRONT and ID_CARD_BACK must be submitted.

ID_CARD_BACK: A file containing only the back of the ID card. In order for a document to be usable, both the ID_CARD_FRONT and ID_CARD_BACK must be submitted.

DRIVING_LICENCE_FRONT: A file containing only the front of the driving licence. In order for a document to be usable, both the DRIVING_LICENCE_FRONT and DRIVING_LICENCE_BACK must be submitted.

DRIVING_LICENCE_BACK: A file containing only the back of the driving licence. In order for a document to be usable, both the DRIVING_LICENCE_FRONT and DRIVING_LICENCE_FRONT must be submitted.

filenamestring
Filename of the document.
legalArrangementCodestring
The Adyen-generated legalArrangementCode to which the document must be linked.
legalArrangementEntityCodestring
The Adyen-generated legalArrangementEntityCode to which the document must be linked.
shareholderCodestring
The Adyen-generated shareholderCode to which the document must be linked. Refer to Verification checks for details on when a document should be submitted.

Required if the account holder has a legalEntity of type Business and the documentType is either PASSPORT, ID_CARD_FRONT, ID_CARD_BACK, DRIVING_LICENCE_FRONT, or DRIVING_LICENCE_BACK.

signatoryCodestring
The Adyen-generated signatoryCode to which the document must be linked.
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
400 - Bad Request
A problem reading or understanding the request.
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.
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.
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.
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.
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 documents

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error