Skip to main content

Criminal Record of the Federal Police - Status

Description​

Polls the status of a previously initiated criminal background check. While the check is still processing, the response will contain status: "IN_PROGRESS". Once completed, the result will include an items array with the warrant validation records. When no warrant records are found for the person, the fields inside items will be null.

Asynchronous Flow

This API uses an asynchronous two-step process:

  1. Initiate the check — returns a ref ticket with status IN_PROGRESS (HTTP 202). The process may take up to 2 minutes to complete.
  2. Poll for results — use the ref ticket to poll until the result is available (HTTP 200).
info

Before proceeding, make sure you have your jwt token, if you don't, check the login documentation.


Step 2 — Poll for results​

HTTP method GET​

Endpoint​

https://api.msla-id.com/experience-background-criminalrecord-api-v1/api/idv-govcheck/v1/br-identity/{cpfNumber}/check-criminal-records/status/{ref}
[SANDBOX Environment]

For testing purposes, use the base domain: apidev.msla-id.com

Request header parameter​

NAMEREQUIREDTYPEDESCRIPTION
Authorization✅stringBearer JWT token

URI request parameters​

NAMEREQUIREDTYPEDESCRIPTION
cpfNumber✅stringCPF number of the person (same as used in Step 1).
ref✅stringReference ticket obtained from Step 1.

Status code responses​

CodeDescription
200IN_PROGRESS (keep polling) or completed result
400Bad request
401Unauthorized
403Forbidden
500Internal server error

Response 200 status code — In Progress​

{
"traceId": "d638df58b52151ec",
"timestamp": "2026-03-11 11:21:41",
"data": {
"ref": "06479633377-a3f1bc2e-2",
"status": "IN_PROGRESS"
}
}

Response 200 status code — Completed (with records)​

{
"traceId": "d638df58b52151ec",
"timestamp": "2026-03-11 11:21:41",
"data": {
"items": [
{
"IDV_name": "Antecedentes Criminais - NOVO",
"description": "Não devem constar antecedentes criminais",
"result": "VALID"
}
]
}
}

Response 200 status code — Completed (no records found)​

{
"traceId": "d638df58b52151ec",
"timestamp": "2026-03-11 11:21:41",
"data": {
"items": [
{
"IDV_name": null,
"description": null,
"result": null
}
]
}
}

Response body fields — Validation item object​

FIELDTYPEDESCRIPTION
IDV_namestringName of the validation rule. null if no records found.
descriptionstringDescription of the validation rule. null if no records.
resultstringValidation result (VALID or INVALID). null if none.

Response 400 status code​

{
"traceId": "542fc743fffda052",
"timestamp": "2023-05-05 11:20:46",
"code": "IDV-4005",
"message": "-"
}

Response 500 status code​

{
"traceId": "43a20f33d4e8730d",
"timestamp": "yyyy-mm-dd HH:MM:SS",
"code": "IDV-1001",
"message": "A generic error has occurred."
}