Documentação para desenvolvedores
Tudo para integrar a verificação de identidade do ProValidFace: uma primeira verificação em dez minutos, webhooks assinados, as três jornadas, o sandbox, a referência OpenAPI e uma coleção do Postman.
Escolha o seu caminho
Quem integra pela API começa pelo quickstart; quem só quer enviar um link usa o console, sem escrever código.
Quickstart de 10 minutos
Da chave de teste à primeira verificação aprovada: criar a sessão, abrir o link do titular e ler o resultado.
Webhooks
Receba o resultado assim que a decisão sai, com assinatura HMAC-SHA256, retentativas e reenvio.
Jornadas e sandbox
As jornadas Leve, Padrão e Rigorosa, os limiares de cada uma e os marcadores que forçam cada desfecho no sandbox.
Referência OpenAPI
Todos os endpoints, campos e respostas no Swagger gerado a partir do próprio código, sempre igual ao que roda.
Coleção do Postman
As chamadas principais já montadas, com as variáveis base_url e api_key para preencher e testar.
Changelog
O que mudou na plataforma, por data, do mais recente para o mais antigo.
O que vale para toda a API
Base e autenticação
A API v1 fica em https://api.provalidface.com.br/api/v1. Toda chamada leva a chave no cabeçalho Authorization: Bearer vf_test_... (sandbox) ou vf_live_... (produção). A chave define a empresa: nada de identificar a empresa pelo corpo.
Erros com código estável
As falhas vêm no formato {"error": {"code": "...", "message": "..."}}. O código é estável e serve para o seu tratamento; a mensagem é para leitura humana.
Idempotência
Ao criar uma verificação, envie o cabeçalho Idempotency-Key. A repetição com a mesma chave devolve a mesma sessão, sem criar (nem cobrar) outra.
Limite de requisições
Cada chave tem um limite por minuto. Ao estourar, a resposta é 429 com o cabeçalho Retry-After em segundos. Trial e cota respondem 402 e 429 antes de qualquer análise.