Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-1341128.0 KB
Bulk

Submit a batch of CPFs for asynchronous lookup

Accepts a list of CPFs and queues them for background processing. Returns immediately with a jobId used to poll /cpf/bulk/{jobId} for status.

  • Invalid-format CPFs are filtered out before processing and reported in data.invalid.
  • Only CPFs found in the database (found) consume credits, same rule as GET /cpf/{cpf}.
  • Maximum 10,000 CPFs per request (CPF_BULK_MAX). Exceeding it returns 400.
  • Per-CPF results are returned inline by GET /cpf/bulk/{jobId} once processed.
post/cpf/bulk

Request body

cpfsstring[] required

List of CPFs, formatted or not. Max 10,000 per request (CPF_BULK_MAX) — exceeding it returns 400.

fileNamestring

Optional reference name for the batch, shown in history.

format'CSV' | 'TXT' | 'Texto'

Optional, informational only — origin format of the batch.

Example request

{
  "cpfs": [
    "10415045606",
    "11144477735",
    "39114856620"
  ],
  "fileName": "clientes-junho.csv"
}

Response

Batch accepted and queued for processing

successboolean required

Example response

{
  "success": true
}
All 4 operations