Issuer Query by Filters
This endpoint allows querying issuers registered in the system using the document number (CNPJ) or Name.
Request
ENDPOINT
/issuer_management/issuerMETHOD
GETQuery Params
| Field | Type | Description | Required |
|---|---|---|---|
document_number | string | Issuer document number. | No |
name | string | Issuer name. | No |
page | integer | Current page of the query. | No |
rows_per_page | integer | Number of records per page. | No |
Response
STATUS
200Response Body
{
"data": [
{
"issuer_key": "495ae701-5c38-49b1-b517-a3b910fe8d8f",
"name": "Empresa Exemplo S.A.",
"document_number": "12.345.678/0001-95",
"status": "in_filling"
}
],
"pagination": {
"current_page": 1,
"next_page": null,
"rows_per_page": 100,
"total_pages": 1,
"total_rows": 1
}
}
Response Body Params
| Field | Type | Description | |
|---|---|---|---|
data | list | List of results | Simplified Issuer Object |
pagination | object | Pagination data | Pagination Object |
Simplified Issuer Object
| Field | Type | Description | Max Characters |
|---|---|---|---|
issuer_key | string | Unique issuer identifier (UUID v4). | 36 |
name | string | Full issuer name. | 255 |
document_number | string | Issuer document number (CNPJ). | 14 |
status | string | Current issuer status. | status Enumerators |
status Enumerators
| Enum | Description |
|---|---|
in_filling | In filling |
in_analysis | Under analysis |
canceled | Canceled |
approved | Approved |
reproved | Rejected |
expired | Expired |
Pagination Object
| Field | Type | Description |
|---|---|---|
current_page | integer | Current page of the query. |
next_page | integer | Next page, if it exists. |
rows_per_page | integer | Number of records per page. |
total_pages | integer | Total number of pages. |
total_rows | integer | Total number of records found. |