Skip to main content

Issuer Query by Filters

This endpoint allows querying issuers registered in the system using the document number (CNPJ) or Name.


Request

ENDPOINT
/issuer_management/issuer
METHOD
GET

Query Params

FieldTypeDescriptionRequired
document_numberstringIssuer document number.No
namestringIssuer name.No
pageintegerCurrent page of the query.No
rows_per_pageintegerNumber of records per page.No

Response

STATUS
200
Response 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

FieldTypeDescription
datalistList of resultsSimplified Issuer Object
paginationobjectPagination dataPagination Object

Simplified Issuer Object

FieldTypeDescriptionMax Characters
issuer_keystringUnique issuer identifier (UUID v4).36
namestringFull issuer name.255
document_numberstringIssuer document number (CNPJ).14
statusstringCurrent issuer status.status Enumerators

status Enumerators

EnumDescription
in_fillingIn filling
in_analysisUnder analysis
canceledCanceled
approvedApproved
reprovedRejected
expiredExpired

Pagination Object

FieldTypeDescription
current_pageintegerCurrent page of the query.
next_pageintegerNext page, if it exists.
rows_per_pageintegerNumber of records per page.
total_pagesintegerTotal number of pages.
total_rowsintegerTotal number of records found.