Guia de verificação da migração

O guia a seguir irá ajudá-lo a migrar do Verify Legacy, que está obsoleto, para Verify. Para isso, você precisa atualizar as URLs dos seus endpoints para que chamem a nova versão e modificar as configurações do seu aplicativo; não é necessário preencher nenhum formulário de pré-registro para começar a usar Verify.

Resumo

A API Vonage Verify é um serviço que permite aos desenvolvedores implementar a autenticação de dois fatores (2FA) para proteger contra fraudes e garantir a autenticidade do usuário. A Vonage oferece duas versões dessa API: a Legacy e a atual Verify. Embora ambas as versões tenham a mesma função principal, há diferenças significativas em seus recursos, funcionalidades e uso.

Principais diferenças

• Flexibilidade e personalização: Verify agora oferece uma criação de fluxos de trabalho mais flexível e opções de personalização aprimoradas, como um sistema de gerenciamento de modelos personalizados com mais recursos em comparação com a versão antiga.
• Suporte ao canal: O “Verify” agora oferece suporte adicional para verificação por meio de vários novos canais, como Silent Auth, RCS, WhatsApp e e-mail, enquanto o “Legacy” se limita a SMS e chamadas de voz.
• Recursos de segurança: O Verify agora inclui recursos de segurança aprimorados e está em conformidade com as normas mais recentes.
• Proteção contra fraudes: Os clientes que migrarem do Verify Legacy para a nova API do Verify terão proteção e acesso a Vonage Fraud Defender Advanced sem custo adicional.
• Tratamento de erros: O “Verify” agora oferece mensagens de erro mais detalhadas e um tratamento aprimorado, além de mecanismos mais avançados de limitação de taxa e de novas tentativas automáticas.
• Projeto e integração de APIs: O Verify oferece suporte tanto a padrões de integração síncronos quanto assíncronos.

Comparação de recursos

Chamadas de API

O modo assíncrono foi introduzido no Verify, permitindo que você receba mensagens e status de chamadas por webhook, recebendo tanto eventos (no caso de whatsapp_interactive) e callbacks de resumo. Você também pode usá-lo de forma síncrona com redirect_url e check_url.

Você deve configurar seus webhooks para os callbacks do Verify na seção “Aplicativo” do Painel do Cliente:

É possível encontrar mais documentação sobre webhooks em aqui.

Pontos finais

Todas as chamadas à API do Verify precisam ser atualizadas para usar o novo endpoint:

Fluxos de trabalho

Verify oferece a flexibilidade de definir seu próprio fluxo de trabalho, ao contrário dos fluxos de trabalho fixos do Legacy. Você pode especificar qualquer combinação de canais de suporte de sua escolha no fluxo de trabalho, até um máximo de três canais.

É possível encontrar mais documentação sobre fluxos de trabalho aqui.

Canais

Agora há novos canais disponíveis no Verify:

• SMS
• Voz (anteriormente TTS na versão antiga)
• WhatsApp
• E-mail
• Autenticação silenciosa
• RCS

Para obter informações mais detalhadas sobre esses canais, consulte o Especificação da API.

A documentação específica sobre autenticação silenciosa pode ser encontrada aqui.

Callbacks de resumo

As chamadas de retorno são enviadas ao seu webhook com o status do evento, correspondente request_id & canal. Os diagramas de sequência a seguir mostram como isso funciona ao usar um único canal ou vários canais em seu fluxo de trabalho.

Canal único

Vários canais

Códigos de resposta

Além de alterar seus endpoints, suas Applications também precisam ser atualizadas para reconhecer os códigos de resposta recebidos ao usar o Verify:

Cancelamento de solicitação

Modelos

Conformidade com a PSD2

Solicitação de verificação de pesquisa

Gestão de fraudes

Verify diagramas de sequência

Verify o fluxo

Verify solicitação com callbacks de resumo

Diagrama de sequência de autenticação silenciosa

Verify a análise dos parâmetros de carga útil entre a V1 e a V2

Enviar solicitação de verificação

Solicitação de verificação de cheque

Solicitação de verificação de pesquisa

Cancelar solicitação de verificação

Iniciar o próximo processo de verificação

Modelos personalizados

Conformidade com a PSD2

Mapeamento do fluxo de trabalho entre o Verify V1 e o Verify V2

Fluxo de trabalho 1 (padrão)

Padrão: SMS → TTS → TTS

Verify V1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 1
}

Verify V2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

Fluxo de trabalho 2

Padrão: SMS → SMS → TTS

Verify V1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 2
}

Verify V2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "sms", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

Fluxo de trabalho 3

Padrão: TTS → TTS

Verify V1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 3
}

Verify V2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "voice", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

Fluxo de trabalho 4

Padrão: SMS → SMS

Verify V1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 4
}

Verify V2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "sms", "to": "15555551234"}
  ]
}

Fluxo de trabalho 5

Padrão: SMS → TTS

Verify V1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 5
}

Verify V2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

Fluxo de trabalho 6

Padrão: SMS

Verify V1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 6
}

Verify V2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"}
  ]
}

Fluxo de trabalho 7

Padrão: TTS

Verify V1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 7
}

Verify V2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "voice", "to": "15555551234"}
  ]
}