Sign in

v1

latestOpenAPI 3.1.02026-07-245361280.3 KB
Onboard accounts

Update account information and upload documents

This service is responsible for updating KYC information for an account and uploading its documents.

patch/v2/accounts/{account_id}/kyc

Path parameters

account_idstring required

User’s dLocal account ID.

Request body

filestring[]

Upload and submit various documents required for KYC account validation. Each file name must include an extension, which can be either .jpeg, .png, or .pdf.<br><br>Please refer to the list of acceptable files.

Example request

{
  "body": {
    "consents": [
      {
        "type": "DATA_COLLECTION",
        "name": "John Doe",
        "accepted": true
      }
    ],
    "company_information": {
      "ip_address": "127.0.0.1",
      "ubos": [
        {
          "document_type": "DNI",
          "document_expedition_date": "2012-06-28",
          "name": "Jose Lopez",
          "nationality": "UY",
          "country": "UY",
          "city": "Montevideo",
          "address": "Dr. Luis Bonavita 1234",
          "date_of_birth": "1990-04-25",
          "email": "legalrepresentative@email.com",
          "ownership_percentage": 15.5
        }
      ]
    }
  }
}

Response

OK

account_idstring

User’s dLocal account ID.

account_external_referencestring byte

ID given by the merchant in their system.

account_emailstring

Account's email address.

statusstring

Account status. See details.

status_codenumber

Account status code. See details.

status_detailstring

Account status detail.

creation_datestring date

Bank account creation's timestamp. ISO-8601 - Notification’s timestamp (YYYY-MM-DDTHH:mm:ss.SSSSZ).

last_updatedstring date-time

Account update timestamp. ISO-8601 - Notification’s timestamp (YYYY-MM-DDTHH:mm:ss.SSSSZ).

platform_typestring byte

Merchant Type, e.g. “MERCHANTNAME”. Each Marketplace will have one or more Merchant types, defined in the Platform account’s creation.</br></br>See details.

account_countrystring

Account's country code. ISO 3166-1 alpha-2 code.

Example response

{
  "account_id": "d907f733-5e17-4470-b963-f2ac2c11a440",
  "account_email": "email@platforms.com",
  "status": "APPROVED",
  "status_code": 200,
  "status_detail": "approved",
  "creation_date": "2021-07-12T12:07:08-00:00",
  "last_updated": "2021-07-12T13:07:08.000Z",
  "platform_type": "MERCHANTNAME",
  "account_country": "AR",
  "capabilities": [
    {
      "capability_name": "PAYINS",
      "capability_status": "ENABLED"
    }
  ],
  "consents": [
    {
      "type": "DATA_COLLECTION",
      "name": "John Doe",
      "accepted": true,
      "updated_date": "2021-07-12T12:07:08-00:00"
    }
  ]
}