Documents

Get documents

Returns the documentation required for the verification. Requirements may differ per verification.

The service may return more than one list item with the same document name (e.g. multiple SOURCE_OF_FUNDS_DECLARATION entries). Each entry has its own id and status; all required items must be completed and approved as applicable.

Documents must be submitted and validated by dLocal before the verification can be approved and related holds (e.g. payouts) released.

get/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

Response

Successful response

current_pageinteger

Current result page.

total_pagesinteger

Total result pages.

page_sizeinteger

Number of results per page.

totalinteger

Total number of results to paginate.

Example response

{
  "items": [
    {
      "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"
    }
  ],
  "total_pages": 10,
  "page_size": 20,
  "total": 200
}

Changes

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