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

🚧

Atenção - Data de Lançamento

As alterações de contrato do recebedor serão disponibilizadas no dia 21 de março de 2024.

👍

Versões de integração v1 a v3

Todas as nossas versões anteriores são retrocompatíveis com a v4, ou seja, todas as alterações realizamos para esta versão de integração estarão também disponíveis nas demais versões, seguindo o mesmo contrato e obrigatoriedades.

Adição do novo objeto kyc_details

Para criação de KYC para recebedores veja aqui.

Com o objetivo de facilitar a adaptação ao novo processo de Validação de Identidade, disponibilizaremos uma rota direta para a webapp em que os recebedores poderão passar pelo processo de KYC biométrico com prova de vida de forma totalmente autônoma.

Após a criação de um recebedor, disponibilizaremos o endpoint de criação do QR Code de acesso a webapp, que deverá ser renderizado pelo Marketplace por uma ação do recebedor e disponibilizado para que finalize seu processo de ativação da sua loja com a Pagar.me.

📘

Importante - Transacional

O recebedor estará apto a transacionar mesmo antes de concluir o processo de prova de vida, porém para movimentar seu saldo é necessário concluir e ser aprovador no KYC.

Adicionaremos o objeto kyc_details ao contrato de recebedores na API v4 e a partir deste objeto e do status será possível acompanhar o processo de análise e ativação do recebedor.

Fluxo de credenciamento do recebedor:

1. Criar recebedor na rota POST/recipients: No response você haverá as informações de status do recebedor e KYC recipient.status = registration e kyc_details.status = pending
2. Aguardar o recebedor estar pronto para o processo de kyc: Quando o recebedor estiver pronto você receberá um postback de recipient.updated com os status recipient.status = affiliation e kyc_details.status = partially_denied
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: Quando o recebedor finalizar o preenchimento do KYC você receberá um postback de recipient.updated com os status recipient.status=affiliation, kyc_details.status = pending e kyc_details.status_reason = in_analysis
6. Aguardar o retorno da análise do KYC: Após a conclusão da análise você receberá um postback de recipient.updated com os status variando de acordo com o resultado:
   1. Necessário o repreenchimento do KYC:Retornar ao passo 3, os status retornarão para recipient.status = affiliation e kyc_details.status = partially_denied
   2. Recebedor aprovado: recipient.status = active e kyc_details.status = approved
   3. Recebedor reprovado: recipient.status = inactive e kyc_details.status = denied neste caso o status_reason será sempre fully_denied e não há mais ações possíveis para credenciar este cliente em nossa base. A solução será criar novamente
      Observação: O motivo da recusa será enviado no status_reason

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/1/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 - postback

As atualizações de status após a análise dos dados do recebedor serão realizadas de forma assíncrona.

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