Skip to main content

Consulta de Emissores por filtros

Este endpoint permite consultar emissores cadastrados no sistema utilizando o número de documento (CNPJ) ou Nome.


Request

ENDPOINT
/issuer_management/issuer
MÉTODO
GET

Query Params

CampoTipoDescriçãoObrigatório
document_numberstringNúmero do documento do emissor.Não
namestringNome do emissor.Não
pageintegerPágina atual da consulta.Não
rows_per_pageintegerNúmero de registros por página.Não

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

CampoTipoDescrição
datalistLista de resultadosObjeto Emissor Simplificado
paginationobjectDados de paginaçãoObjeto Paginação

Objeto Emissor Simplificado

CampoTipoDescriçãoMáximo de Caracteres
issuer_keystringIdentificador único do emissor (UUID v4).36
namestringNome completo do emissor.255
document_numberstringNúmero do documento do emissor (CNPJ).14
statusstringStatus atual do emissor.Enumeradores status

Enumeradores status

EnumDescription
in_fillingEm preenchimento
in_analysisEm análise
canceledCancelado
approvedAprovado
reprovedReprovado
expiredExpirado

Objeto Pagination

CampoTipoDescrição
current_pageintegerPágina atual da consulta.
next_pageintegerPróxima página, caso exista.
rows_per_pageintegerNúmero de registros por página.
total_pagesintegerNúmero total de páginas.
total_rowsintegerNúmero total de registros encontrados.