Acompanhar um lote

Devolve o andamento do lote e, quando ele termina, os resultados paginados. Só a conta que criou o lote consegue ler.

Parâmetros

idstringobrigatório

No caminho. O batch_id devolvido pelo POST /v1/cpf/batch.

pagenumber

Na query. Página dos resultados, a partir de 1. Padrão: 1.

per_pagenumber

Na query. Itens por página, de 1 a 500. Padrão: 100.

statusstring

Na query. Filtra por found, not_found, invalid, error ou insufficient_credits.

Gratuito.

• Os resultados só aparecem quando o lote termina (status completed). Antes disso, a resposta traz apenas o andamento.
• Valores inválidos nos parâmetros respondem 400 com o código INVALID_QUERY. Lote inexistente ou expirado responde 404 com BATCH_NOT_FOUND.

Itens de results

indexnumber

Posição do item na lista enviada, a partir de 0.

cpfstring

CPF sanitizado.

statusstring

Resultado do item (tabela abaixo).

codenumber

Código HTTP equivalente ao item.

messagestring

Explicação, quando o item não foi encontrado.

dataobject

Objeto CPF, presente quando o status é found.

Status de cada item