DLdlocal
Documents

Update document

Updates a specific document using multipart/form-data.

Allowed only when document status is PENDING. After COMPLETED, ERROR, or APPROVED, PATCH updates are rejected.

patch/verifications/{verification-id}/documents/{document-id}

Request

  • Base URL
    https://api.dlocal.com/kyc
  • URL
    https://api.dlocal.com/kyc/verifications/{verification-id}/documents/{document-id}
  • 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

filestring binary

File with the content of the document to update. It's used for documents of type DOCUMENT and should only be used if value is not sent. Each file name must include an extension, which can be either .jpeg, .png, or .pdf. Please refer to the list of acceptable documents.

valuestring

Value of the document to update. It's used for documents of type FIELD and should only be used if file is not sent.

reference_namestring

Reference name given by the merchant in their system.

Response

Successful response

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.