API

Integrate Identity into your platform with total control and flexibility through our API.

How is the API integration?

It is the ideal integration method if you want to have full control over the identity validation flow experience. It is the ideal option for companies that already have their user data.

You will be able to directly collect all the data and documentation from your platform and send it through our API. You will integrate with the KYC endpoints and through webhook you will receive updates on the status of the session.

Scope

You will have to use this solution:

• Whenever you contract Cards in 🇧🇷Brazil and in 🇨🇱Chile.
• When you contract Cards in 🇦🇷Argentina and Pomelo acts as the obligated party.

Steps for integration

1. Create the corresponding Pomelo users for that session, through the Users API. To create this new user_id, you only need the email that identifies the user on your platform.

2. Create an identity validation session, via API, select "[Country] - [Accounts/Cards] - API". For this, you will need the user_id that you generated in the previous step. We will send you the session URL through the endpoint, so you can redirect your client to that flow.

3. Upload the required documents for user validation. Use the endpoint for "Upload File" once per document.

4. You will receive a notification, via webhook at the endpoint you define, with the result of the identity validation process.

Functionality

Below, we indicate how we need to receive all the data, photos, and documentation for each of your users: