ADadyen
Documents

Update a document

Changed on

Updates a document.

You can upload a maximum of 15 pages for photo IDs.

Requests to this endpoint are subject to rate limits:

  • Live environments: 700 requests per 5 seconds.

  • Test environments: 200 requests per 5 seconds.

  • Failed requests are subject to a limit of 5 failures per 10 seconds.

patch/documents/{id}

Request

  • Base URL
    https://kyc-test.adyen.com/lem/v1
  • URL
    https://kyc-test.adyen.com/lem/v1/documents/{id}
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

idstring required

The unique identifier of the document to be updated.

Headers

x-requested-verification-codestring

Use the requested verification code 0_0001 to resolve any suberrors associated with the document. Requested verification codes can only be used in your test environment.

Request body

creationDatestring date-time

The creation date of the document.

descriptionstring required

Your description for the document.

expiryDatestring

The expiry date of the document, in YYYY-MM-DD format.

fileNamestring

The filename of the document.

idstring

The unique identifier of the document.

issuerCountrystring

The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US.

issuerStatestring

The state or province where the document was issued (AU only).

modificationDatestring date-time

The modification date of the document.

numberstring

The number in the document.

type'bankStatement' | 'driversLicense' | 'identityCard' | 'nationalIdNumber' | 'passport' | 'proofOfAddress' | 'proofOfNationalIdNumber' | 'proofOfResidency' | 'registrationDocument' | 'taxDocument' | 'proofOfIndustry' required

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, taxDocument, proofOfOwnership, or proofOfIndustry.

  • For individual, the type values can be identityCard, driversLicense, proofOfNationalIdNumber, proofOfResidency, or proofOfIndustry.

  • Use bankStatement to upload documents for a transfer instrument.

Response

OK - the request has succeeded.

creationDatestring date-time

The creation date of the document.

descriptionstring required

Your description for the document.

expiryDatestring

The expiry date of the document, in YYYY-MM-DD format.

fileNamestring

The filename of the document.

idstring

The unique identifier of the document.

issuerCountrystring

The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US.

issuerStatestring

The state or province where the document was issued (AU only).

modificationDatestring date-time

The modification date of the document.

numberstring

The number in the document.

type'bankStatement' | 'driversLicense' | 'identityCard' | 'nationalIdNumber' | 'passport' | 'proofOfAddress' | 'proofOfNationalIdNumber' | 'proofOfResidency' | 'registrationDocument' | 'taxDocument' | 'proofOfIndustry' required

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, taxDocument, proofOfOwnership, or proofOfIndustry.

  • For individual, the type values can be identityCard, driversLicense, proofOfNationalIdNumber, proofOfResidency, or proofOfIndustry.

  • Use bankStatement to upload documents for a transfer instrument.

Changes