Referência da API
Cada endpoint, cada campo, cada erro para o qual você pode se planejar.
Desenvolvedores
Documentação da API de verificação de identidade, feita para ser usada de verdade.
Uma API REST, uma página hospedada para as partes que você não quer construir e webhooks assinados para você saber no instante em que um resultado chega. Chaves sandbox nunca são cobradas, então a forma mais rápida de entender o ShieldID é chamá-lo.
A versão de cinco minutos
Quatro chamadas. Um modelo mental.
Todo o resto desta documentação é detalhe sobre este ciclo.
Crie uma sessão
POST /v1/sessions com uma URL de retorno e uma URL de webhook. Você recebe de volta um session_id e uma verification_url.Entregue ao solicitante
Envie a verification_url como link, ou deixe que a pessoa escaneie o QR code que a página hospedada exibe no desktop. Ela conclui no próprio celular.Receba um webhook assinado
Quando a sessão chega a VERIFIED ou FAILED, o ShieldID envia o resultado por POST para a sua URL de webhook, assinado para que você possa confiar que veio de nós.Leia o resultado
Confie no webhook ou chame GET /v1/sessions/{id}/result você mesmo. De qualquer forma, você recebe veredictos por verificação, não uma única pontuação opaca.
Experimente
Crie sua primeira sessão.
A mesma requisição em três linguagens. É a chamada que o primeiro passo do modelo mental descreve.
bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
-H "X-Api-Key: vk_sand_your_key" \
-H "Content-Type: application/json" \
-d '{
"return_url": "https://yourapp.example/verified",
"webhook_url": "https://yourapp.example/hooks/shieldid"
}'
# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }Chaves sandbox (vk_sand_…) executam exatamente este fluxo de graça. Troque por uma chave vk_live_ e nada mais muda, exceto a fatura.
Encontre seu caminho
O restante da documentação para desenvolvedores.
Seis páginas. Leia as que você precisar.
Início rápido
Da chave sandbox ao primeiro webhook assinado, em ordem.
SDKs
O widget web, o fluxo hospedado e o que vem por aí.
Sandbox
Como o modo de teste funciona e como obter uma chave.
Status
Sobre o que vamos informar, quando o feed estiver no ar.
Changelog
O que foi lançado e quando.
Sandbox
Teste o fluxo completo antes de assinar qualquer coisa.
Uma chave de sandbox (prefixo vk_sand_) executa a mesma API, a mesma página hospedada e o mesmo fluxo de webhook da produção. As sessões são marcadas com environment: "sandbox" em todos os lugares em que aparecem, e sessões de sandbox nunca são cobradas, em nenhum plano.
- Crie sessões reais, verifique um documento real no seu próprio celular e receba de volta um webhook assinado real
- Nada do que você fizer no sandbox afeta uma fatura
- Para passar à produção, basta trocar o prefixo da chave; o formato da requisição não muda
Construído às claras
O que já está pronto e o que ainda não está.
Preferimos contar a você a deixar que descubra no meio da integração.
Callbacks de conclusão do widget web
Em breveonComplete, onCancel e onStep existem hoje na interface do widget, mas nada os dispara ainda. Use a URL de retorno e o webhook — ambos funcionam agora.
Limites de taxa aplicados
Em breveToda chave de API tem um limite de taxa registrado de acordo com o seu plano, mas ele ainda não é aplicado às requisições — planeje-se de acordo e não conte com o ShieldID para limitar o seu tráfego.
Cadastro self-service no sandbox
Em breveAs chaves de sandbox são emitidas sob solicitação enquanto o cadastro self-service está em desenvolvimento. Peça a sua e a entregaremos rapidamente.
Perguntas
Respostas diretas para desenvolvedores.
Comece agora
Entre em produção em uma tarde.
Comece com uma chave de sandbox, faça uma verificação no seu próprio celular e leia o webhook que ele envia a você. Sem precisar de reunião com vendas.
As sessões em sandbox nunca são cobradas.