Onboarding in Brazil

Create a Customer

Begin by creating a customer and saving the customerId generated in the response.

{
    "email": "[email protected]",
    "type": "INDIVIDUAL"
}

{
    "customerId": "69396270-172e-4055-a4a5-6ab719e78b22",
    "createdAt": "2024-12-03T14:44:55.123Z"
}

Add KYC Info

Once you have created a customer, you can now add their KYC information. This will create a new KYC submissionId, which can be used to track their KYC status.

{
  "kycSubmission": {
    "firstName": "Guilherme",
    "lastName": "Rodrigues",
    "dateOfBirth": "1988-11-08",
    "country": "BR",
    "city": "Porto Alegre",
    "zipCode": "90020",
    "address": "Rua dos Andradas 946",
    "state": "Rio Grande do Sul ",
    "nationalities": ["Brazilian"],
    "phoneNumber": "+5194878237",
    "cpf": "11111111111",
    "occupation": "Product Manager"
    }
}

{
    "submissionId": "4b34e815-f48b-4c7f-8bb9-3e86aac0c2ec",
    "createdAt": "2024-12-03T14:44:59.434Z",
    "firstName": "Guilherme",
    "lastName": "Rodrigues",
    "dateOfBirth": "1988-11-08",
    "country": "BR",
    "city": "Porto Alegre",
    "zipCode": "90020",
    "address": "Rua dos Andradas 946",
    "state": "Rio Grande do Sul ",
    "nationalities": [
        "Brazilian"
    ],
    "phoneNumber": "+5194878237",
    "cpf": "11111111111",
    "occupation": "Product Manager"
}

KYC Required Fields

Field	Required	Type
firstName	true	string
lastName	true	string
dateOfBirth	true	date
country	true	string
countryCode	true	string
city	true	string
zipCode	true	string
address	true	string
state	true	string
nationalities	true	array
National ID Front	false	file_upload
National ID Back	false	file_upload

Add KYC Files

Next, upload copies of the front and back of the customer's CPF (Cadastro de Pessoas Físicas) using the Add KYC Files endpoint.

Submit KYC

Once all of the required information and files have been uploaded, the next step is to Submit the KYC submission to be processed.

Complete KYC

In the Sandbox environment, you will need to call the Create Webhook endpoint to move the KYC into COMPLETEDstatus.

{
  "referenceId": "{{submissionId}}",
  "eventType": "KYC",
  "status": "COMPLETED",
  "metadata": null
}

Finally, the Customer KYC is complete. Now, it is time to add their payment method and begin transacting.