Skip to content
Vai integrar a API do Zarv ID com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a API do Zarv ID. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/zarv-id/post-api-v2-verifications-batch
- Spec OpenAPI (fonte da verdade para rotas e schemas): https://developers.zarv.com/openapi/zarv-api.json
- Autenticação: https://developers.zarv.com/api/zarv-id/authentication
- Webhook de verificação: https://developers.zarv.com/api/zarv-id/webhook
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

O spec OpenAPI acima é a fonte da verdade para rotas, parâmetros e schemas — confira nele antes de escrever qualquer request. A decisão final chega por webhook, não pela resposta da chamada que cria a verificação.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: criar uma verificação de identidade e tratar o webhook de resultado]

Criar verificações em lote

POST
/api/v2/verifications/batch

Cria uma verificação para cada nationalId da lista, aplicando a mesma configuração de verifications a todos os itens. Cada item é validado e cobrado individualmente; o resultado de cada um vem em items, um mapa indexado pelo nationalId. Itens aceitos retornam id (verification ID) para polling posterior; itens rejeitados retornam error. Face recognition e CNH não são suportados em lote — se presentes no corpo, são ignorados.

Authorizations

Authentication v2

For more details, see Authentication v2

Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"nationalId": [
  
  
"012345678900"
  
],
  
"verifications": {
  
  
"type": "full",
  
  
"finance": {
  
  
  
"restrictions": true
  
  
}
  
},
  
"callback": {
  
  
"url": "https://example.com/webhooks/verifications",
  
  
"method": "POST",
  
  
"headers": {
  
  
  
"additionalProperties": "string"
  
  
}
  
},
  
"metadata": {
  
  
"additionalProperties": "string"
  
}
}

Responses

Lote aceito para processamento. A resposta contém o resumo do lote e, em items, o status de cada nationalId enviado.

application/json
JSON
{
  
"total": 0,
  
"success": 0,
  
"errors": 0,
  
"items": {
  
  
"additionalProperties": {
  
  
  
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  
  
  
"error": "There is not enough balance: insufficient balance"
  
  
}
  
}
}