post
https://api.somossimpay.com.br/v2/finance/get-customer/?document_number=
Query Params
| Key | Type | Description | Example |
|---|---|---|---|
| document_number | Number | The CPF number to be validated (formatted as 12345678909) | EX: 15799286930 |
Headers
| Parameter | Type | Description | Example |
|---|---|---|---|
| Authorization | String | Bearer + Access_token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo |
Response Details
{
"worked": true,
"customer": {
"name": "RxxxxxN DA xxxxx CxxxxxO",
"cpf": "15xxx286xxx",
"rg": "xxxxxxxxxxx",
"gender": "MASCULINO",
"birth_date": "1xx7-x9-x6",
"nationality": "Brasileiro",
"dead": false
}
}
| Field | Description |
|---|---|
| worked | Returns true or false, indicating whether CPF validation and data retrieval were successful. |
| name | This field returns the full name associated with the provided CPF. |
| cpf | This field returns the CPF of the individual (the same information that was provided in the query parameters) |
| rg | This field returns the RG (Registro Geral) document associated with the provided CPF |
| gender | This field returns the gender associated with the provided CPF. |
| birth_date | This field returns the date of birth associated with the provided CPF. |
| dead | This field indicates the status of the CPF, specifying whether the individual is currently active (False) or deceased (True). |
