KYC Verifications API

The KYC Verifications API will offer various types of verifications. Each will determine the specific information required for that particular flow.

This API outlines the process for creating and managing verifications, providing a more transparent and efficient approach to handling information that requires additional verification.. Each will determine the specific information required for that particular flow.

This API will allow merchants to:

Create a verification
Update a verification by uploading the required information.
Retrieve the status of a verification and its documents.
Notify the systems or the merchant about any significant updates on the verification.

Verifications services endpoints

Service	Method & endpoint	Description
Create a verification	POST /verifications	This service can be used to create a verification.
Get verification details	GET /verifications/{verification-id}	This service can be used to retrieve a verification.
Get documents	GET /verifications/{verification-id}/documents	This service can be used to retrieve the required documentation that needs to be sent for a given verification. These documents must be sent and validated by dLocal for the verification to be approved.
Update document	PATCH /verifications/{verification-id}/documents/{document-id}	This service is responsible for updating a specific document associated with a given verification using a multipart/form-data request. Depending on the type of document and its status, the information is allowed to be updated. Operation is only permitted when the document has a status: `PENDING`. Once the document status changes to `COMPLETED`, ERROR, or `APPROVED`, updates via `PATCH` will not be possible.

Environment URLs: Sandbox and Production

URLs

URL Selector with Opacity

Production URL Sandbox URL

Sandbox

There is a test environment available for integration development and testing, which simulates most of the requests and transaction types available in the platform. You can use this environment to ensure your requests are handled accordingly.

📘
Please note that in the test environment no transactions will actually be processed.

Production

After the testing phase is successful, you are ready to go live in the production environment.

Pagination

The API pagination behaves uniformly throughout the API, with its structure being as follows

Response example

{
  "items": [
    {}
  ],
  "current_page": 0,
  "total_pages": 1,
  "page_size": 1,
  "total": 1
}

Field description

Field	Type	Description
`code`	String	Error’s code
`message`	String	Error’s description.
`field`	String	Field indicating the parameter associated with the reported error.

Get your API credentials

Remember that all dLocal API requests require API credentials to verify the call is being made through a valid dLocal account.

🚧
Please contact your Technical Account Manager to obtain them.