get
https://api.caas.staging.bancocdc.com.br/client/document/list/
Purpose of listing documents
Attention point:
To consume the route, it's necessary to pass the client's code as a parameter.
Response
| Http Code | Return Code | Message |
|---|---|---|
| 200 | 200-01 | Success. |
| 400 | 400-01 | Something unexpected happened. |
| 400 | 400-52 | Customer was not found. |
| 400 | 400-80 | Document not found |
| 401 | 401-05 | Unauthorized or token invalid |
| 406 | 406-01 | User was not found. |
| 406 | 406-03 | Field 'X' is mandatory and was not informed. |
Response Parameters
| Parameters | Format | Description |
|---|---|---|
| request_code | String | Unique identifier for the request. |
| return | Boolean | Indicates if the request was successful or not. |
| return_code | String | Code representing the status of the request. |
| message | String | Message describing the result of the request. |
| data | Array | List of retrieved documents. |
| data.code | String | Unique identifier for the document. |
| data.type | String | Type of the document. |
| data.description | String | Description of the document. |
| data.created_at | DateTime | Date and time when the document was created. |