API

Integre a Identidade na sua plataforma com controle total e flexibilidade através da nossa API.

Como é a integração via API?

É o método de integração ideal se você quer ter controle total sobre a experiência no fluxo de validação de identidade. É a opção ideal para empresas que já possuem os dados de suas empresas.

Você poderá coletar diretamente da sua plataforma todos os dados e documentação e enviá-los através da nossa API. Você se integrará com os endpoints de KYB e receberá atualizações sobre o estado da sessão através de webhook.

Abrangência

Atualmente, está disponível na 🇦🇷Argentina e no 🇧🇷Brasil.

Etapas para a integração

Etapas para a integração

  1. Criar uma empresa Pomelo, através da nossa API de Empresas. Para criar esse novo company_id, você só precisará do ID fiscal da empresa.

  2. Crie os usuários Pomelo correspondentes para essa sessão, através da API de Usuários. Para criar este novo user_id, você só precisa do e-mail que identifica o usuário na sua plataforma.

  3. Crie uma sessão de validação de identidade para a empresa, por meio da API. Selecione o "[País] - [Contas/Cartões] - API". Nesse endpoint, você deve enviar os dados da empresa, proprietários e representantes legais.

  4. Envie os documentos necessários para a validação da empresa. Use este endpoint um de cada vez para cada documento.

  5. Você receberá uma notificação, via webhook no endpoint que você definiu, com o resultado do processo de validação de identidade.

Se a sessão terminar em estado (NOT VALIDATED)[/pt/docs/identity/sessiones-and-states/invalid-sessions], você receberá no webhook detalhes sobre o motivo do erro. Assim, você poderá explicar ao seu cliente e ele poderá tentar novamente.

Funcionamento

A seguir, indicamos como precisamos receber todos os dados, fotos e documentação de cada um dos seus usuários:

Registro de funcionário

Ao criar uma empresa, você também poderá criar usuários adicionais de indivíduos associados à empresa, ou seja, seus funcionários. Para fazer isso, você deve usar o endpoint "Criar Sessão - Adicionais".

  1.  Crie os usuários correspondentes da Pomelo para essa sessão, através da API de Users. Para criar este novo user_id, você só precisará do e-mail que identifica o usuário na sua plataforma.
  2.  Crie uma sessão de validação de identidade via API, selecionando "[País] - [Accounts/Cards] - Additional - API". Para isso, você precisará do user_id que gerou na etapa anterior. A este ponto de extremidade, você deve enviar os dados do usuário.
  3.  Você receberá uma notificação via webhook no ponto de extremidade que você definir, com o resultado do processo de validação de identidade.

O conteúdo desta documentação foi útil?