Guia de Integração de Webhooks: Verificação de Identidade em Tempo Real (PT-BR)

Atualizações em Tempo RealWebhooks fornecem notificações imediatas sobre mudanças no status da verificação de identidade, permitindo respostas instantâneas e melhor experiência do usuário.

Segurança AprimoradaMétodos de verificação de assinatura garantem a autenticidade das requisições de webhook, protegendo seu aplicativo contra agentes maliciosos.

Integração FlexívelMúltiplos headers de assinatura acomodam vários cenários de integração, garantindo compatibilidade com diferentes frameworks web e middleware.

Workflows Simplificados com a DiditA plataforma da Didit oferece fácil configuração de webhook e documentação abrangente, permitindo que desenvolvedores integrem rapidamente notificações de verificação de identidade em tempo real em seus aplicativos.

Entendendo Webhooks na Verificação de Identidade

Webhooks são um componente crucial para construir workflows de verificação de identidade responsivos e eficientes. Eles habilitam a comunicação em tempo real entre a plataforma de verificação de identidade da Didit e seu aplicativo, fornecendo atualizações imediatas sobre o status das sessões de verificação. Em vez de constantemente verificar atualizações, seu aplicativo recebe notificações instantâneas quando o status de uma sessão muda (por exemplo, de 'Não Iniciado' para 'Em Progresso', ou de 'Em Análise' para 'Aprovado'). Isso permite que você automatize processos, melhore a experiência do usuário e responda rapidamente a quaisquer problemas.

Por exemplo, imagine um cenário onde um usuário envia seu documento de identidade para verificação. Sem webhooks, seu aplicativo precisaria verificar periodicamente o status da verificação. Com webhooks, assim que a verificação é aprovada, seu aplicativo recebe uma notificação e pode imediatamente conceder ao usuário acesso ao serviço. Isso reduz a latência e proporciona uma experiência mais suave e integrada.

Configurando Webhooks para a Verificação de Identidade da Didit

Configurar webhooks com a Didit é um processo direto. Primeiro, você precisa configurar seu time e aplicativo dentro da plataforma Didit. Então, navegue até as configurações de verificação e insira sua URL de webhook. Esta URL é onde a Didit enviará as notificações em tempo real. Também é essencial copiar a Chave Secreta do Webhook, que você usará para validar as requisições de entrada e garantir que elas sejam genuinamente da Didit.

Para garantir a segurança do seu endpoint de webhook, a Didit fornece múltiplos métodos de verificação de assinatura. Esses métodos usam uma chave secreta para criar um hash do payload do webhook, que você pode então comparar com a assinatura incluída na requisição do webhook. Isso garante que a requisição é autêntica e não foi adulterada. Se você estiver usando Cloudflare, você deve adicionar o endereço IP da Didit (18.203.201.92) à lista de permissões para receber webhooks.

Métodos de Verificação de Assinatura: Garantindo a Autenticidade do Webhook

A Didit oferece três headers de assinatura para acomodar diferentes cenários de integração:

• X-Signature: Este assina os bytes JSON brutos exatos enviados no corpo da requisição. Requer acesso direto ao corpo bruto da requisição antes de qualquer análise ou re-codificação e pode falhar se o middleware re-codificar caracteres Unicode de forma diferente.
• X-Signature-V2: O método recomendado, ele assina JSON Unicode não escapado. Funciona mesmo se seu middleware re-codificar o JSON, tornando-o compatível com a maioria dos frameworks web.
• X-Signature-Simple: Este assina apenas os campos principais: "{timestamp}:{session_id}:{status}:{webhook_type}". É completamente independente da codificação JSON, mas não verifica a integridade da decisão ou outros campos.

Recomendamos tentar X-Signature-V2 primeiro, pois funciona mesmo se seu middleware re-codificar o JSON. Se o V2 falhar, volte para X-Signature-Simple. Use X-Signature apenas se você tiver acesso direto aos bytes brutos da requisição.

Tipos de Evento de Webhook e Estrutura de Dados

A Didit envia webhooks para os seguintes tipos de evento:

• status.updated: Acionado sempre que o status da verificação muda. Isso inclui o webhook inicial enviado quando uma sessão é iniciada.
• data.updated: Acionado quando os dados KYC ou de Comprovante de Endereço (POA) são atualizados manualmente por um revisor via API. Isso permite que você permaneça sincronizado com correções de dados ou análises manuais.

Cada payload de webhook inclui um campo webhook_type indicando o evento que o acionou. Se o status da sessão for Approved, Declined, In Review ou Abandoned, o webhook também incluirá um campo decision contendo resultados detalhados da verificação. O session_id é sempre incluído, e os campos vendor_data, workflow_id e metadata são incluídos apenas se estiverem presentes na sessão.

Manipulando Retentativas e Erros de Webhook

Se a entrega de um webhook falhar (ou seja, seu endpoint retorna um código de status HTTP diferente de 200), a Didit tentará novamente a entrega até cinco vezes com backoff exponencial. Após cinco tentativas falhas, o webhook será descartado. É crucial garantir que seu endpoint de webhook seja confiável e possa lidar com as requisições de entrada prontamente. Você também deve implementar registro de erros e monitoramento para identificar e resolver quaisquer problemas que possam causar falhas na entrega do webhook.

Para evitar problemas, garanta que seu servidor possa lidar com a carga esperada de eventos de webhook. Além disso, valide a assinatura do webhook para confirmar a autenticidade da requisição e implemente o tratamento de erros adequado para gerenciar problemas inesperados com elegância. Ao seguir essas práticas recomendadas, você pode garantir uma integração de webhook confiável e segura com a plataforma de verificação de identidade da Didit.

Como a Didit Ajuda

A Didit simplifica a integração de notificações de verificação de identidade em tempo real através de sua plataforma amigável e documentação abrangente. O conjunto de verificação de identidade da Didit, incluindo Verificação de Identidade, Detecção de Liveness Passiva e Ativa e Monitoramento e Triagem AML, é projetado para ser modular e facilmente integrado em sistemas existentes.

A plataforma da Didit é nativa de IA, permitindo recursos avançados e precisão superior na verificação de identidade. As opções flexíveis de configuração de webhook e os múltiplos métodos de verificação de assinatura garantem que seu aplicativo receba atualizações seguras e confiáveis em tempo real. Além disso, com o nível Free Core KYC da Didit, você pode começar a integrar webhooks e verificar identidades sem nenhuma taxa de configuração.

Escolha a Didit como seu provedor de verificação de identidade e beneficie-se de uma abordagem focada no desenvolvedor, acesso instantâneo ao sandbox e APIs limpas. Automatize seus workflows e melhore sua experiência de usuário com a plataforma robusta e escalável da Didit.

Pronto para Começar?

Pronto para ver a Didit em ação? Agende uma demonstração gratuita hoje.

Comece a verificar identidades gratuitamente com o nível gratuito da Didit.