Bulk
Check the status of a batch job
Returns progress, counts, and per-CPF results for a batch job created via POST /cpf/bulk. Poll this endpoint until data.status is done or failed.
- data.cpfs contains one object per processed CPF, enriched from the local database for found: true rows (same fields as GET /cpf/{cpf}).
- While status is processing, data.cpfs reflects only what has been persisted so far and grows on each poll.
- skipped CPFs (not processed due to insufficient credits) never appear in data.cpfs.
- Unlike GET /cpf/{cpf}, the cpf field inside data.cpfs is not formatted (plain 11 digits, no punctuation).
get/cpf/bulk/{jobId}
Path parameters
jobIdstring uuid required
The jobId returned by POST /cpf/bulk.
Response
Job status returned successfully
Example response
{
"success": true,
"data": {
"cpfs": [
{
"cpf": "11144477735",
"name": "Ana de Exemplo",
"nameUpper": "ANA DE EXEMPLO",
"gender": "F",
"birthDate": "01/01/1990",
"day": 1,
"month": 1,
"year": 1990
}
]
}
}