Documents

Update multiple documents

Updates several documents for the same verification in one request using multipart/form-data. Each document update is sent as its own part in the multipart body — repeat the part shape (id + file or value, plus optional reference_name) for every document you want to update in the same call.

Same rules as single-document update: changes are only allowed while each target document is in PENDING (not when COMPLETED, ERROR, or APPROVED). The response is an array with one document object per updated item.

patch/verifications/{verification-id}/documents

Request

  • Base URL
    https://api.dlocal.com/kyc
  • URL
    https://api.dlocal.com/kyc/verifications/{verification-id}/documents
  • Auth
    API key in header X-Date and API key in header X-Login and API key in header X-Trans-Key and API key in header Authorization

Request body multipart/form-data

idstring required

dLocal verification document ID for the document being updated.

filestring binary

File with the content of the document to update. Used for documents of type DOCUMENT and only when value is not sent. Each file name must include an extension (.jpeg, .png, or .pdf). Please refer to the list of acceptable documents.

valuestring

Value of the document to update. Used for documents of type FIELD and only when file is not sent.

reference_namestring

Reference name given by the merchant in their system.

Example request

{
  "id": "VD-61e2877d-a7e7-4214-8aa7-fdf0aa6538d5"
}

Response

Successful response — one document object per updated item

idstring

dLocal document verification ID.

typestring

Document type. See details.

namestring

Document name. See details.

reference_namestring

Reference name given by the merchant in their system.

valuestring

Value of the document for documents of type FIELD.

statusstring

Document status. See details.

status_detailstring

Document status detail. See details.

Example response

[
  {
    "id": "VD-61e2877d-a7e7-4214-8aa7-fdf0aa6538d5",
    "type": "DOCUMENT",
    "name": "DOCUMENT_FRONT",
    "reference_name": "customer-copy-of-id-front",
    "value": "John Doe",
    "status": "PENDING",
    "status_detail": "PENDING"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.