Get documents

POST

/getUploadedDocuments

Verification

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/getUploadedDocuments' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountHolderCode": "string",
    "bankAccountUUID": "string",
    "shareholderCode": "string"
}'

Response Example

200 - Example 1

{
    "documentDetails": [
        {
            "accountHolderCode": "string",
            "bankAccountUUID": "string",
            "description": "string",
            "documentType": "BANK_STATEMENT",
            "filename": "string",
            "legalArrangementCode": "string",
            "legalArrangementEntityCode": "string",
            "shareholderCode": "string",
            "signatoryCode": "string"
        }
    ],
    "invalidFields": [
        {
            "errorCode": 0,
            "errorDescription": "string",
            "fieldType": {
                "field": "string",
                "fieldName": "accountCode",
                "shareholderCode": "string"
            }
        }
    ],
    "pspReference": "string",
    "resultCode": "string"
}

Request

Body Params application/json

accountHolderCode

string

required

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

bankAccountUUID

string

optional

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

shareholderCode

string

optional

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

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

documentDetails

array[object (DocumentDetail) {9}]

optional

A list of the documents and their details.

accountHolderCode

string

optional

The code of account holder, to which the document applies.

bankAccountUUID

string

optional

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.

description

string

optional

Description of the document.

documentType

enum<string>

required

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.

Allowed values:

BANK_STATEMENTBSNCOMPANY_REGISTRATION_SCREENINGCONSTITUTIONAL_DOCUMENTDRIVING_LICENCEDRIVING_LICENCE_BACKDRIVING_LICENCE_FRONTID_CARDID_CARD_BACKID_CARD_FRONTPASSPORTPROOF_OF_RESIDENCYSSNSUPPORTING_DOCUMENTS

filename

string

optional

Filename of the document.

legalArrangementCode

string

optional

The Adyen-generated legalArrangementCode to which the document must be linked.

legalArrangementEntityCode

string

optional

The Adyen-generated legalArrangementEntityCode to which the document must be linked.

shareholderCode

string

optional

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.

signatoryCode

string

optional

The Adyen-generated signatoryCode to which the document must be linked.

invalidFields

array[object (ErrorFieldType) {3}]

optional

Contains field validation errors that would prevent requests from being processed.

errorCode

integer <int32>

optional

The validation error code.

errorDescription

string

optional

A description of the validation error.

fieldType

object (FieldType)

optional

The type of error field.

pspReference

string

optional

The reference of a request. Can be used to uniquely identify the request.

resultCode

string

optional

The result code.

🟠400Bad Request - a problem reading or understanding the request.

🟠401Unauthorized - authentication required.

🟠403Forbidden - insufficient permissions to process the request.

🟠422Unprocessable Entity - a request validation error.

🔴500Internal Server Error - the server could not process the request.

Delete signatories

Upload a document