Seguir un lote
GET/v1/cpf/batch/{id}
Devuelve el avance del lote y, cuando termina, los resultados paginados. Solo la cuenta que creó el lote puede leerlo.
Parámetros
- idstringobligatorio
- En la ruta. El
batch_iddevuelto porPOST /v1/cpf/batch. - pagenumber
- En la query. Página de resultados, desde 1. Por defecto: 1.
- per_pagenumber
- En la query. Elementos por página, de 1 a 500. Por defecto: 100.
- statusstring
- En la query. Filtra por
found,not_found,invalid,erroroinsufficient_credits.
Gratis.
- Los resultados solo aparecen cuando el lote termina (estado
completed). Antes, la respuesta trae solo el avance. - Valores inválidos en los parámetros responden 400 con el código
INVALID_QUERY. Un lote inexistente o vencido responde 404 conBATCH_NOT_FOUND.
Elementos de results
- indexnumber
- Posición del elemento en la lista enviada, desde 0.
- cpfstring
- CPF sanitizado.
- statusstring
- Resultado del elemento (tabla de abajo).
- codenumber
- Código HTTP equivalente al elemento.
- messagestring
- Explicación, cuando el elemento no fue encontrado.
- dataobject
- Objeto CPF, presente cuando el estado es
found.
Estado de cada elemento
| found | 200 | Encontrado. Cobra 1 crédito. |
| not_found | 404 | CPF válido, pero sin registro. No se cobra. |
| invalid | 400 / 422 | Formato o dígito verificador inválido. No se cobra. |
| insufficient_credits | 402 | El saldo se acabó antes de este elemento. No se cobra. |
| error | 503 | Falla temporal del proveedor. No se cobra. Reenvíe este elemento. |
cURL
1curl https://api.brazid.com/v1/cpf/batch/0c1e7f3a-5b2d-4e8a-9c41-6d3f0a8b7e12?per_page=100 \2 -H "x-api-key: $BRAZID_API_KEY"
1const res = await fetch('https://api.brazid.com/v1/cpf/batch/0c1e7f3a-5b2d-4e8a-9c41-6d3f0a8b7e12?per_page=100', {2 headers: { 'x-api-key': process.env.BRAZID_API_KEY },3});4 5const data = await res.json();6console.log(res.status, data);
1import os2import requests3 4res = requests.get(5 "https://api.brazid.com/v1/cpf/batch/0c1e7f3a-5b2d-4e8a-9c41-6d3f0a8b7e12?per_page=100",6 headers={"x-api-key": os.environ["BRAZID_API_KEY"]},7)8 9print(res.status_code, res.json())
1$ch = curl_init("https://api.brazid.com/v1/cpf/batch/0c1e7f3a-5b2d-4e8a-9c41-6d3f0a8b7e12?per_page=100");2curl_setopt_array($ch, [3 CURLOPT_RETURNTRANSFER => true,4 CURLOPT_HTTPHEADER => ["x-api-key: " . getenv("BRAZID_API_KEY")],5]);6 7$data = json_decode(curl_exec($ch), true);8$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
200 OK
1{2 "success": true,3 "batch_id": "0c1e7f3a-5b2d-4e8a-9c41-6d3f0a8b7e12",4 "status": "completed",5 "total": 2,6 "processed": 2,7 "progress_percent": 100,8 "summary": {9 "found": 1,10 "not_found": 1,11 "invalid": 0,12 "errors": 0,13 "insufficient_credits": 014 },15 "created_at": "2026-10-16T14:02:11.000Z",16 "completed_at": "2026-10-16T14:02:13.000Z",17 "results": [18 {19 "index": 0,20 "cpf": "52998224725",21 "status": "found",22 "code": 200,23 "data": {24 "cpf": "52998224725",25 "name": "MARIA SOUZA LIMA",26 "birthdate": "26/11/1982",27 "day": 26,28 "month": 11,29 "year": 1982,30 "situation": "REGULAR",31 "social_name": null,32 "registration_date": "12/03/2004"33 }34 },35 {36 "index": 1,37 "cpf": "11144477735",38 "status": "not_found",39 "code": 404,40 "message": "CPF not found"41 }42 ],43 "pagination": {44 "page": 1,45 "per_page": 100,46 "total_results": 2,47 "total_pages": 148 }49}