Skip to main content

National Bank of Arrest Warrants - Request

Description​

Initiates a check against the database of arrest warrants issued by the Banco Nacional de Mandados de PrisΓ£o (BNMP). The check runs asynchronously β€” the POST endpoint immediately returns a ref ticket, and you poll the GET status endpoint until the result is ready (usually within 2 minutes).

info

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


Step 1 β€” Initiate the check​

HTTP method POST​

Endpoint​

https://api.msla-id.com/experience-background-arrestwarrants-api-v1/api/idv-govcheck/v1/br-identity/{cpfNumber}/check-national-bank-arrest-warrants
[SANDBOX Environment]

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

Request header parameters​

NAMEREQUIREDTYPEDESCRIPTION
Authorizationβœ…stringBearer JWT token

URI request parameters​

NAMEREQUIREDTYPEDESCRIPTION
cpfNumberβœ…stringCPF number of the person (digits only)

Request body parameters​

NAMEREQUIREDTYPEDESCRIPTION
emailβœ…stringEmail address for the KYC email check stage

Request body example​

{
"email": "example@gmail.com"
}

Status code responses​

CodeDescription
202Accepted β€” check initiated
400Bad request
401Unauthorized
403Forbidden
500Internal server error

Response 202 status code​

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

Save the data.ref value β€” you will need it to poll for the result in Step 2.

Response 400 status code​

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

Response 401 status code​

{
"timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
"status": 401,
"error": "Unauthorized",
"path": "/api/idv-govcheck/v1/br-identity/{cpfNumber}/check-national-bank-arrest-warrants"
}

Response 403 status code​

{
"traceId": "string",
"timestamp": "string",
"code": "string",
"message": "Forbidden"
}

Response 500 status code​

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