API v5 - Adição do fluxo de Prova de Vida

Adição do novo objeto kyc_details

Com o objetivo de facilitar a adaptação no novo processo de Validação de Identidade, disponibilizaremos uma webapp em que os recebedores poderão passar pelo processo de KYC com biometria.

No fluxo de criação de um novo recebedor, será disponibilizado um QR Code de acesso ao webapp, que deverá ser renderizado pelo Marketplace e disponibilizado para que o recebedor finalize seu processo de credenciamento.

📘

Status do recebedor e transacional

O recebedor estará apto a transacionar mesmo antes de enviar a prova de vida, com status registration.

Entretanto, ele somente conseguirá movimentar seu saldo após a conclusão do credenciamento e tiver o status active.

Caso você tenha gerado saldo, mas foi recusado após biometria, deve entrar em contato com [email protected].

Para tornar possível a Validação de Identidade com Prova de Vida (KYC) para os vendedores de marketplaces, um novo objeto chamado kyc_details será adicionado no contrato de recebedores na API v5.

A partir deste objeto e do status do recebedor você poderá acompanhar o processo de análise e credenciamento do recebedor.

📘

Recebedores já existentes

Não será necessário atualizar a base atual de recebedores com o fluxo de KYC (prova de vida).

Fluxo de credenciamento do recebedor:

1. Criar recebedor na rota POST/recipient: No response você receberá as informações com os status recipient.status = registration. Na criação ainda não é retornado kyc_details.
2. Aguardar o recebedor estar pronto para o processo de kyc: Quando o recebedor estiver pronto você receberá um webhook de recipient.updated com os status recipient.status = affiliation , kyc_details.status = partially_denied e kyc_details.status_reason = additional_documents_required
   1. Existem cenários no qual o recebedor já foi rejeitado na análise de risco diretamente sem a oportunidade de passar por biometria. Nesses casos, os retornos serão pelo mesmo webhook e sempre com o recipient.status = refused. Os campos de poderão ser enviados como kyc_details.status = denied e kyc_details.status_reason = fully_denied ou poderão não ser enviados.
3. Criar link para o preenchimento do KYC na rota POST/recipients/{id}/kyc_link
4. Disponibilizar o link gerado ao recebedor para preenchimento
5. Aguardar o preenchimento do recebedor e análise do KYC: Quando o recebedor finalizar o preenchimento do KYC, você receberá um webhook de recipient.updated com os status variando de acordo com o resultado:
   1. Recebedor aprovado: recipient.status = active, kyc_details.status = approved ekyc_details.status_reason = ok
   2. Recebedor reprovado: recipient.status = refused ,kyc_details.status = denied ekyc_details.status_reason = fully_denied. Não há mais ações possíveis para credenciar este cliente em nossa base. Para entender o motivo de recusa, deve-se entrar em contato com o time de atendimento

🚧

Expiração do Link para KYC

O Link/Qrcode de KYC tem uma expiração de 20 minutos. Isso quer dizer que, após passados 20 minutos da criação, o link não irá mais funcionar, e o marketplace precisará criar um novo link para disponibiliza-lo para preenchimento do recebedor.

Especificação do objeto kyc_details

Adição de nova rota de criação de link

Quando o recebedor atingir o status de affiliation e seu kyc_details for partially_denied será necessário realizar o envio do QR Code de acesso ao webapp.

Após o envio, o recebedor fará o preenchimento da prova de vida para prosseguir com o credenciamento.

[Contrato da rota de criação de link]

curl --request POST \
     --url https://api.pagar.me/core/v5/recipients/{id}/kyc_link \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

{
  "base64":"BJ1B51JK2B51KJ2B5=",
  "url": "www.pagar.me/kyc/14214214215",
  "expiration_date": "2024-02-10T20:35:46.046Z"
}

📘

Mudanças de status do recebedor e kyc_details - Webhooks

As atualizações de status após a análise dos dados do recebedor serão realizadas de forma assíncrona. Os webhooks são disparados com base na alteração de status do recebedor e não com a alteração de status do KYC.

Por esse motivo para receber as atualizações de status do recebedor, é necessário utilizar o webhookde recipient.updated.

Demonstração fluxo de prova de vida