Get the background check status of a CPF

Status of the latest background check of the CPF. A CPF never checked answers 200 with status NOT_FOUND. Never writes anything and never returns the CPF.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

CPF to look up, with or without mask. Not returned in any response field other than the provider payload in processes[].raw, which may contain it.

string

requestedAt returned by the POST (ISO 8601). Covers the window before the check starts.

Responses

400

Bad Request. internalCode INVALID_CPF: the CPF is missing or invalid (11 digits, with or without mask).

401

Unauthorized: The token is invalid or expired.

403

Forbidden. internalCode BG_CHECK_PUBLIC_API_DISABLED: the background check public API is not enabled for this client.

429

Too Many Requests: Rate limit exceeded (per API client).

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json