Follow a batch

Returns the batch progress and, once it finishes, the paginated results. Only the account that created the batch can read it.

Parameters

idstringrequired

In the path. The batch_id returned by POST /v1/cpf/batch.

pagenumber

In the query. Results page, starting at 1. Default: 1.

per_pagenumber

In the query. Items per page, 1 to 500. Default: 100.

statusstring

In the query. Filters by found, not_found, invalid, error or insufficient_credits.

Free.

• Results only appear when the batch finishes (status completed). Before that, the response carries progress only.
• Invalid parameter values answer 400 with the code INVALID_QUERY. A missing or expired batch answers 404 with BATCH_NOT_FOUND.

Items in results

indexnumber

Position of the item in the list you sent, starting at 0.

cpfstring

Sanitized CPF.

statusstring

Item outcome (table below).

codenumber

HTTP code equivalent for the item.

messagestring

Explanation, when the item was not found.

dataobject

CPF object, present when the status is found.

Status of each item