Consulta de CPF em lote

Envia até 1.000 CPFs de uma vez. O processamento é assíncrono: a API responde 202 com um batch_id e você acompanha o andamento ou aguarda o webhook.

Corpo da requisição

[]arrayobrigatório

Lista de 1 a 1.000 itens. CPFs repetidos contam uma vez.

[].cpfstringobrigatório

CPF com ou sem pontuação.

[].birthdatestringobrigatório

Data de nascimento, AAAA-MM-DD.

1 crédito por item encontrado.

• O saldo precisa cobrir o lote inteiro, a menos que o seu plano permita excedente. Sem saldo, a resposta é 402 e o lote não começa.
• Itens inválidos, não encontrados e falhas do provedor não cobram. Você pode reenviar apenas os que falharam.

Como o lote é processado

1. 1

   Você envia a lista

   A API valida cada item e reserva o processamento. A resposta 202 traz o batch_id.

2. 2

   Respostas rápidas

   O que já foi consultado recentemente é resolvido imediatamente. O restante segue para a fonte oficial em segundo plano.

3. 3

   Você acompanha

   Consulte o GET /v1/cpf/batch/{id} até o status ser completed, ou receba o evento batch.completed no seu webhook.

4. 4

   Você lê os resultados

   Os resultados saem paginados e ficam disponíveis por 24 horas.

Campos da resposta 202

batch_idstring

Identificador do lote. Use-o para acompanhar.

statusstring

processing ou completed.

totalnumber

Quantidade de itens do lote.

processednumber

Itens já resolvidos.

found / not_found / invalid / errorsnumber

Contadores por resultado até o momento.

status_urlstring

Caminho para acompanhar o lote. Também vem no cabeçalho Location.

credits_remainingnumber

Saldo após os itens já cobrados. Pode ser ocultado no painel.