API

Integra Identity en tu plataforma con total control y flexibilidad a través de nuestra API.


¿Cómo es la integración por API?

Es el método de integración ideal si quieres tener un control total sobre la experiencia en el flujo de validación de identidad. Es la opción ideal para empresas que ya cuentan con los datos de sus compañías

Podrás recopilar directamente desde tu plataforma todos los datos y la documentación y enviarlos a través de nuestra API. Te integrarás con los endpoints de KYB y a través de webhook recibirás actualizaciones sobre el estado de la sesión.

Alcance

Actualmente, está disponible en 🇦🇷Argentina y 🇧🇷Brasil.

Pasos para la integración

Pasos para la integración

  1. Crear una compañía de Pomelo, a través de nuestra API de Compañías. Para crear este nuevo company_id solo necesitarás el ID fiscal de la compañía.

  2. Crear los usuarios de Pomelo correspondientes para esa sesión, a través de API de Users. Para crear este nuevo user_id solo necesitarás el mail que identifica al usuario en tu plataforma.

  3. Crear una sesión de validación de identidad para la compañía, vía API. Selecciona el "[País] - [Accounts/Cards] - API". A este endpoint debes enviar los datos de la compañía, dueños y representantes legales.

  4. Subir los documentos requeridos para la validación de la compañía. Utiliza este endpoint dale de a una vez por documento.

  5. Recibirás una notificación, vía webhook en el endpoint que definas, con el resultado del proceso de validación de identidad.

Si la sesión termina en estado (NOT VALIDATED)[/docs/cards/issuing/identity/invalid-sessions], recibirás en el webhook detalles sobre el motivo del error. Así podrás explicarle a tu cliente y podrá intentarlo nuevamente.

Funcionamiento

A continuación, te indicamos cómo necesitamos recibir todos los datos, fotos y la documentación de cada uno de tu usuarios:

Registro de empleados

Al crear una compañía, también podrás crear usuarios adicionales de personas físicas asociadas a la compañía, es decir, tus empleados. Para esto debes utilizar el endpoint "Crear Sesión - Adicionales".

  1.  Crear los usuarios de Pomelo correspondientes para esa sesión, a través de API de Users. Para crear este nuevo user_id solo necesitarás el mail que identifica al usuario en tu plataforma.
  2.  Crear una sesión de validación de identidad, vía API, selecciona "[País] - [Accounts/Cards] - Additional - API". Para esto necesitarás el user_id que generaste en el paso anterior. A este endpoint debes enviar los datos del usuario.
  3.  Recibirás una notificación, vía webhook en el endpoint que definas, con el resultado del proceso de validación de identidad.

¿Te resultó útil el contenido de esta documentación?