Webhook de confirmação de conta

Uma vez que o processo de onboarding é encerrado, o cliente deverá receber uma notificação via webhook com o status final do onboarding.

Detalhamento do webhook

Este webhook é enviado para o cliente no encerramento do onboarding. O metódo da requisição sempre será POST. Dentro do body da requisição você encontrará o status final do onboarding, aprovado ou negado. Caso o onboarding tenha sido aprovado, a requisição poderá conter a chave Pix gerada para a conta, caso o Partner esteja configurado para gerar automaticamente as chaves. A lista de errors irá vazia. Em caso de um onboarding rejeitado, os motivos da rejeição estarão descritos no campo errors. O campo "errors" será uma lista, cada um com informações sobre o identificador do erro, campo relacionado, motivo, status e sugestão de correção para uma nova tentativa.

JSON de Exemplo

JSON (Sucesso)

{
  "identifier": "e298e4f7-5a1f-4bbb-ba46-b6cbf4bcf3a2",
  "status": "APPROVED",
  "documentNumber": "fake_data",
  "transactionKey": "e298e4f7-5a1f-4bbb-ba46-b6cbf4bcf3a2",
  "errors": [
  ]
}

JSON (Rejeitada)

{
  "identifier": "e298e4f7-5a1f-4bbb-ba46-b6cbf4bcf3a2",
  "status": "DENIED",
  "documentNumber": "fake_data",
  "transactionKey": "e298e4f7-5a1f-4bbb-ba46-b6cbf4bcf3a2",
  "errors": [
    {
      "field": "fake_data",
      "reason": "fake_data",
      "status": "ADJUSTED",
      "suggestion": "fake_data",
    }
  ]
}

Campos do JSON

Campo	Tipo	Descrição
identifier	String	Identificador da aprovação de conta
status	Enum	Status da aprovação de conta (APPROVED ou DENIED)
documentNumber	String	Número do documento
errors	Array	Lista de erros associados à aprovação
transactionKey	String	Chave pix gerada para conta
└── identifier	String	Identificador do erro
└── field	String	Campo relacionado ao erro
└── reason	String	Motivo do erro
└── status	Enum	Status do erro (PENDING ou ADJUSTED)
└── suggestion	String	Sugestão relacionada ao erro
└── accountIdentifier	String	Identificador da conta associada ao erro