Saltar al contenido

Consulta de CNPJ por lote

POST/v1/cnpj/batch

Envía hasta 1.000 CNPJ a la vez. El procesamiento es asíncrono: la API responde 202 con un batch_id y usted sigue el avance o espera el webhook. La fuente es la misma de la consulta individual: los Datos Abiertos del CNPJ.

Cuerpo de la solicitud

[]arrayobligatorio
Lista de 1 a 1.000 elementos.
[].cnpjstringobligatorio
CNPJ con o sin puntuación, numérico o alfanumérico. También se acepta enviar la lista solo con los textos de los CNPJ.

1 crédito por elemento encontrado.

  • El saldo debe cubrir todo el lote, salvo que su plan permita excedente. Sin saldo, la respuesta es 402 y el lote no comienza.
  • Los elementos inválidos (formato o dígito verificador), no encontrados y las fallas de la fuente no se cobran. Puede reenviar solo los que fallaron.
  • El lote usa el mismo saldo y los mismos límites de solicitudes de la consulta individual.

Cómo se procesa el lote

  1. Usted envía la lista

    La API valida el formato y los dígitos verificadores de cada elemento y encola el trabajo. La respuesta 202 trae el batch_id.

  2. El procesamiento corre en segundo plano

    Cada CNPJ se resuelve en los Datos Abiertos, y solo se cobran los encontrados.

  3. Usted sigue el avance

    Consulte GET /v1/cnpj/batch/{id} hasta que el estado sea completed, o reciba el evento batch.completed en su webhook.

  4. Usted lee los resultados

    Los resultados salen paginados y quedan disponibles por 24 horas.

Campos de la respuesta 202

batch_idstring
Identificador del lote. Úselo para seguir el avance.
statusstring
processing o completed.
totalnumber
Cantidad de elementos del lote.
processednumber
Elementos ya resueltos (al inicio, solo los inválidos).
found / not_found / invalid / errorsnumber
Contadores por resultado hasta el momento.
status_urlstring
Ruta para seguir el lote. También viene en el encabezado Location.
credits_remainingnumber
Saldo actual. Se puede ocultar en el panel.

cURL

1curl -X POST https://api.brazid.com/v1/cnpj/batch \2 -H "x-api-key: $BRAZID_API_KEY" \3 -H "Content-Type: application/json" \4 -d '[{"cnpj":"12.345.678/0001-95"},{"cnpj":"11.222.333/0001-81"}]'

202 Accepted

1{2 "success": true,3 "batch_id": "5d8a2c71-3e94-4b60-a1f7-92c0b4e6d318",4 "status": "processing",5 "total": 2,6 "processed": 0,7 "found": 0,8 "not_found": 0,9 "invalid": 0,10 "errors": 0,11 "status_url": "/v1/cnpj/batch/5d8a2c71-3e94-4b60-a1f7-92c0b4e6d318",12 "credits_remaining": 2013}