get
https://api.caas.staging.bancocdc.com.br/clients
The retrieve route is responsible for fetching information about a specific client.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Attention point:
With this route you can retrieve all your clients.
Response
| Http Code | Return Code | Message |
|---|---|---|
| 200 | 200-01 | Success. |
| 400 | 400-01 | Something unexpected happened. |
| 400 | 400-02 | Invalid hash. |
| 401 | 401-05 | Unauthorized or token invalid |
| 429 | 429-01 | Too many requests |
Response Parameters
| Parameter | Format | Description |
|---|---|---|
| request_code | string | Request code made. |
| return | boolean | Indicates if the request was successful. |
| return_code | string | Return code of the request. |
| message | string | Message indicating the reason for the response. |
| data | object | Object containing additional information. |
| data.code | string | Code associated with the client. |
| data.type_people | string | Type of person (PF or PJ). |
| data.document | string | Client's identification document. |
| data.name | string | Client's name. |
| data.telephone | string | Client's telephone number. |
| data.email | string | Client's email address. |
| data.mother_name | string | Client's mother's name. |
| data.birth_date | string | Client's date of birth. |
| data.gender | string | Client's gender (1 for male, 2 for female). |