Politically Exposed Persons
Descriptionβ
Query on the list of Politically Exposed Persons, made available by the Conselho de Controle de Atividades Financeiras (COAF), a Brazilβs national Financial Intelligence Unit responsible for fighting financial crime.
HTTP method GETβ
Endpointβ
https://8ehec73psb.execute-api.us-west-2.amazonaws.com/uat/identity/api/idv-govcheck/v1/br-identity/{documentNumber}/check-politically-exposed-persons
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 | Idem |
CPF | β | string | Company name |
Status code responsesβ
Code | Description |
---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
404 | Not found |
500 | Internal server error. |
The full documentation error codes can be found here.
Response 200 status codeβ
{
"traceId": "b2345cfc7bee621e",
"timestamp": "2023-05-15 11:59:35",
"data": {
"pep": true,
"country": "BR",
"fullName": "Jose Antonio Saavedra Hernandez",
"PEPdata": [
{
"PEPfullName": "Jose Antonio Saavedra Hernandez",
"state": "DF",
"institution": "Sistema para el Desarrollo Integral de la Familia del Municipio de Victoria.",
"position": "AUXILIAR DE PROGRAMA",
"period": "01/10/2020 - 31/12/2020"
}
]
}
}
Response 400 status codeβ
{
"traceId": "542fc743fffda052",
"timestamp": "2023-05-05 11:20:46",
"code": "IDV-4005",
"message": "-",
"data": null
}
Response 401 status codeβ
{
"timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
"status": 401,
"error": "Unauthorized",
"path": "/api/idv-govcheck/v1/br-identity/{documentNumber}/check-politically-exposed-persons"
}
Response 500 status codeβ
{
"traceId": "43a20f33d4e8730d",
"timestamp": "yyyy-mm-dd HH:MM:SS",
"code": "IDV-1001",
"message": "A generic error has occurred.",
"data": null
}