API

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

How does the API integration work?

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 company data.

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

Scope

Currently available in 🇦🇷Argentina and 🇧🇷Brazil.

Integration steps

1. Create a Pomelo company through our Company API. To create this new company_id, you will only need the company's tax ID.

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

3. Create an identity validation session for the company via API. Select the "[Country] - [Accounts/Cards] - API" option. To this endpoint, you must send the company's data, owners, and legal representatives.

4. Upload the required documents for company validation. Use this  endpoint one document at a time.

5. You will receive a notification via webhook at the defined endpoint with the result of the identity validation process.

Operation

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

Employee registration

When creating a company, you will also be able to create additional users who are individuals associated with the company, in other words, your employees. To do this, you should use the "Create Session - Additional" endpoint.

1.  Create the corresponding Pomelo users for that session through the API de Users. To create this new user_id, you will only need the email that identifies the user on your platform.
   
2.  Create an identity validation session via API, select "[Country] - [Accounts/Cards] - Additional - API". For this, you will need the user_id you generated in the previous step. You should send the user's data to this endpoint.
   
3.  You will receive a notification via a webhook at the endpoint you define, with the result of the identity validation process.