Saltar al contenido

Seguir un lote de CNPJ

GET/v1/cnpj/batch/{id}

Devuelve el avance del lote de CNPJ y, cuando termina, los resultados paginados. Solo la cuenta que creó el lote puede leerlo.

Parámetros

idstringobligatorio
En la ruta. El batch_id devuelto por POST /v1/cnpj/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, error o insufficient_credits.

Gratuito.

  • 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, de CPF o vencido responde 404 con BATCH_NOT_FOUND.

Elementos de results

indexnumber
Posición del elemento en la lista enviada, desde 0.
cnpjstring
CNPJ sanitizado (sin puntuación).
statusstring
Resultado del elemento (misma tabla del lote de CPF).
codenumber
Código HTTP equivalente al elemento.
messagestring
Explicación, cuando el elemento no fue encontrado, es inválido o falló.
dataobject
Datos de la empresa, los mismos de la consulta individual (sin credits_remaining). Presente cuando el estado es found.

Estado de cada elemento

found200Encontrado. Cobra 1 crédito.
not_found404CPF válido, pero sin registro. No se cobra.
invalid400 / 422Formato o dígito verificador inválido. No se cobra.
insufficient_credits402El saldo se acabó antes de este elemento. No se cobra.
error503Falla temporal del proveedor. No se cobra. Reenvíe este elemento.

cURL

1curl https://api.brazid.com/v1/cnpj/batch/5d8a2c71-3e94-4b60-a1f7-92c0b4e6d318?per_page=100 \2 -H "x-api-key: $BRAZID_API_KEY"

200 OK

1{2 "success": true,3 "batch_id": "5d8a2c71-3e94-4b60-a1f7-92c0b4e6d318",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-25T14:02:11.000Z",16 "completed_at": "2026-10-25T14:02:12.000Z",17 "results": [18 {19 "index": 0,20 "cnpj": "12345678000195",21 "status": "found",22 "code": 200,23 "data": {24 "cnpj": "12345678000195",25 "legal_name": "EMPRESA EXEMPLO TECNOLOGIA LTDA",26 "trade_name": "EXEMPLO TECH",27 "status": "ATIVA",28 "status_date": "2020-03-15",29 "opening_date": "2020-03-15",30 "main_cnae": {31 "code": "6201501",32 "text": "Desenvolvimento de programas de computador sob encomenda"33 },34 "address": {35 "city": "SAO PAULO",36 "state": "SP"37 }38 }39 },40 {41 "index": 1,42 "cnpj": "11222333000181",43 "status": "not_found",44 "code": 404,45 "message": "CNPJ not found"46 }47 ],48 "pagination": {49 "page": 1,50 "per_page": 100,51 "total_results": 2,52 "total_pages": 153 }54}