Request the background check of a CPF

Returns the result when a fresh background check exists for the CPF (200), whichever client paid for it. Otherwise starts one, or reports the one in progress, and answers 202. Poll the status route with the same CPF and since=<requestedAt>.

Each paid check counts against the monthly quota of the client (calendar month in America/Sao_Paulo). A fresh result reused from an earlier check does not count. The CPF is not returned in any response field other than processes[].raw, the provider payload, which may contain it.

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

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

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.

409

Conflict, with retryAfterSeconds. internalCode BG_CHECK_RECENTLY_FAILED: the last check failed less than 24h ago. internalCode BG_CHECK_PARTIAL: the last check finished incomplete.

429

Too Many Requests. internalCode MONTHLY_QUOTA_EXCEEDED, with retryAfterSeconds until 00:00 America/Sao_Paulo on the 1st of the next month; or the per-client rate limit.

503

Service Unavailable. internalCode BG_CHECK_QUEUE_UNAVAILABLE or BG_CHECK_RESERVATION_UNAVAILABLE: the request could not be queued; try again.

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