Politically Exposed Persons
Description​
List of Politically exposed persons in Brazil.
HTTP method GET​
Endpoint​
https://api.msla-id.com/experience-background-pep-api-v1/api/idv-govcheck/v1/br-identity/{name}/check-politically-exposed-persons
For testing purposes, use the base domain: apidev.msla-id.com
info
Before proceeding, make sure you have your jwt token, if you don't, check the login documentation.
Request header parameter​
| NAME | REQUIRED | TYPE | DESCRIPTION |
|---|---|---|---|
| Authorization | ✅ | string | bearer jwt token |
URI request parameter​
| NAME | REQUIRED | TYPE | DESCRIPTION |
|---|---|---|---|
| name | ✅ | string | Full name of the person |
Status code responses​
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad request — IDV-3001 |
| 401 | Unauthorized |
| 403 | Forbidden — IDV-1004 |
| 404 | Not found — IDV-1002 Data not found. |
| 500 | Internal server error — IDV-1008 |
| 504 | Gateway timeout — IDV-1100 |
The full documentation error codes can be found here.
Response 200 status code​
{
"traceId": "b2345cfc7bee621e",
"timestamp": "2023-05-15 11:59:35",
"data": {
"cpf": "***.608.252-**",
"fullName": "ABDALA HABIB FRAXE JUNIOR",
"acronymOfFunction": "DEP ES",
"description": "DEPUTADO ESTADUAL",
"levelOfFunction": null,
"nameOfBody": "AMAZONAS",
"startingDate": "01/02/2023",
"finalDate": "31/01/2027",
"finalDateOfPersonConsideredPep": "31/01/2032"
}
}
Response 400 status code​
{
"traceId": "542fc743fffda052",
"timestamp": "2023-05-05 11:20:46",
"code": "IDV-3001",
"message": "Bad request - Invalid or incomplete input data",
"data": null
}
Response 403 status code​
{
"traceId": "43a20f33d4e8730d",
"timestamp": "yyyy-mm-dd HH:MM:SS",
"code": "IDV-1004",
"message": "Forbidden",
"data": null
}
Response 404 status code​
{
"traceId": "43a20f33d4e8730d",
"timestamp": "yyyy-mm-dd HH:MM:SS",
"code": "IDV-1002",
"message": "Data not found."
}
Response 500 status code​
{
"traceId": "43a20f33d4e8730d",
"timestamp": "yyyy-mm-dd HH:MM:SS",
"code": "IDV-1008",
"message": "Error in the source of origin, please contact an administrator!",
"data": null
}
Response 504 status code​
{
"traceId": "43a20f33d4e8730d",
"timestamp": "yyyy-mm-dd HH:MM:SS",
"code": "IDV-1100",
"message": "Gateway Timeout",
"data": null
}