get
https://api.caas.staging.bancocdc.com.br/operation/signature/subscriber/
This route allows for the consultation of registered subscribers.
Attention point:
To query the subscribers in an operation, the operation code is passed as a parameter.
Response
| Http Code | Return Code | Message |
|---|---|---|
| 200 | 200-01 | Success. |
| 400 | 400-01 | Something unexpected happened. |
| 400 | 400-02 | Invalid hash. |
| 400 | 400-09 | There are no results for the query. |
| 401 | 401-05 | Unauthorized or token invalid |
| 429 | 429-01 | Too many requests |
Response Parameters
| Parameter | Format | Description |
|---|---|---|
| request_code | String | Request identification code. |
| return | Boolean | Indicates if the request was successful. |
| return_code | String | Return code of the request. |
| message | String | Return message of the request. |
| data[].code | String | Unique code of the subscriber. |
| data[].document | String | Document number of the subscriber. |
| data[].name | String | Name of the subscriber. |
| data[].telephone | String | Telephone number of the subscriber. |
| data[].email | String | Email address of the subscriber. |
| data[].type_code | String | Type code of the subscriber. |
| data[].type_description | String | Description of the subscriber type. |
| data[].created_at | String | Date and time when the subscriber was created. |