1. Autentique
Crie uma chave no painel e envie-a somente no header X-API-Key.
Referência pública
Integre a API de QR Code VIO
Envie o conteúdo Base64 de um QR Code VIO e receba uma resposta JSON estruturada. A autenticação usa API key e os webhooks são assinados com HMAC-SHA256.
2. Decodifique
Faça POST com JSON estrito e payload Base64 no limite documentado.
3. Automatize
Em planos compatíveis, receba eventos assinados no endpoint HTTPS cadastrado.
POST /api/v1/decode/payload
Use `Content-Type: application/json`. O campo `payload_base64` é obrigatório; `include_photo_base64` controla se a resposta deve incluir a imagem quando o documento oferecer esse dado.
# 1. Defina CONSULTA_API_KEY no ambiente e envie o payload Base64
curl -X POST https://consulta.dev.br/api/v1/decode/payload \
-H "X-API-Key: ${CONSULTA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{"payload_base64": "ZBEiAQVAAEc...", "include_photo_base64": true}'A API retorna códigos 401 para credencial inválida, 413 para corpo acima do limite, 429 para cota excedida e respostas 4xx estáveis para entrada inválida.
Validação de webhooks
Valide sempre a assinatura sobre o corpo bruto, confira a janela do timestamp e armazene o identificador da entrega para impedir processamento duplicado.
signed = X-Webhook-Timestamp + "." + raw_body
expected = "v1=" + HMAC_SHA256(WEBHOOK_SECRET, signed)
# Compare em tempo constante, aceite no máximo 5 minutos
# e deduplique pelo header X-Webhook-Delivery.Dados e segurança
Conheça os documentos catalogados e a política de retenção antes de integrar.