Verificar um documento com a API

A API REST da VerifyPDF permite que seus próprios sistemas verifiquem documentos sem que ninguém precise abrir o painel. Este artigo cobre o fluxo geral. Para os detalhes completos de requisição e resposta, use a referência em /agents/.

Antes de começar

• A API REST está disponível nos planos Professional e Corporate. Ela não está incluída no Basic nem em uma conta sem plano. Veja Planos explicados.
• Você precisa de uma chave de API. Veja Gerar e gerenciar chaves de API.

O fluxo básico

1. Crie uma chave de API na seção Developers e copie-a uma vez.
2. Envie o PDF para a API com sua chave no cabeçalho de requisição API-KEY.
3. Leia o resultado, que volta com a mesma pontuação de confiança e classificação de risco de fraude que você vê no painel. Veja Leia seu resultado de verificação.

Cada verificação pela API consome um documento da sua cota mensal ou do seu saldo pré-pago, exatamente como um envio pelo painel. Veja Como funcionam os pacotes pré-pagos.

Adicione seu próprio id de referência

Você pode anexar um custom_id a uma verificação, por exemplo seu número de caso interno ou id de pedido. Isso permite consultar a verificação depois pela sua própria referência. Cada custom_id precisa ser único dentro da sua conta.

Uma ilustração rápida

Em alto nível, uma requisição envia o PDF junto com o cabeçalho API-KEY contendo sua chave. O endpoint exato, o corpo da requisição e o formato da resposta estão na referência da API em /agents/ e dentro da seção Developers do painel. Use-os para exemplos prontos para copiar, em vez de adivinhar.

Teste primeiro, depois vá para produção

Enquanto você desenvolve, use uma chave test. Mude para uma chave live para verificações reais. Veja Chaves de API test e live.

Próximos passos

• Quer que os resultados sejam enviados a você em vez de ficar consultando? Veja Configurar webhooks.
• Precisa da referência completa? Acesse /agents/.