Skip to content

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

TypeHTTP (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": {
}
}
}