Pular para o conteúdo principal

Consulta de Emissor

Este endpoint permite consultar os detalhes completos de um emissor cadastrado no sistema, utilizando sua chave única.

Request​

ENDPOINT
/issuer_management/issuer/ISSUER-KEY
MÉTODO
GET

Path Params​

CampoTipoDescriçãoCaracteres
ISSUER-KEYstringChave única do emissor (UUID v4).36

Response​

RESPONSE STATUS
200
Response Body com status in_filling
{
    "issuer_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e",
    "name": "Fabrica Exemplo S.A.",
    "document_number": "96.146.194/0001-07",
    "status": "in_filling",
    "backoffice_analysis_status": "in_analysis",
    "person_type": "legal",
    "trading_name": "Fabrica Comércio",
    "cnae_code": "62.02-3-00",
    "company_type": "sa",
    "foundation_date": "2000-01-01",
    "address": {
      "street": "Rua das Empresas",
      "neighborhood": "Centro",
      "number": "123",
      "postal_code": "01001-000",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Sala 101"
    },
    "registration_datetime": "2025-01-23T13:47:57.354528",
    "expiration_date": "2026-01-23",
    "signer_group_list": [],
    "bank_account_list": [],
    "issuer_representative_list": [],
    "issuer_contact_information_list": [],
    "issuer_document_list": [],
    "issuer_analysis_list": [],
    "payment_bank_account": {
        "account_number": "19500",
        "account_digit": "7",
        "account_branch": "0001"
    },
    "annual_revenues": 150000,
    "is_in_national_financial_system": false
}
RESPONSE STATUS
200
Response Body com status reproved
{
    "issuer_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e",
    "name": "Fabrica Exemplo S.A.",
    "document_number": "96.146.194/0001-07",
    "status": "reproved",
    "backoffice_analysis_status": "reproved",
    "person_type": "legal",
    "trading_name": "Fabrica Comércio",
    "cnae_code": "62.02-3-00",
    "company_type": "sa",
    "foundation_date": "2000-01-01",
    "address": {
      "street": "Rua das Empresas",
      "neighborhood": "Centro",
      "number": "123",
      "postal_code": "01001-000",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Sala 101"
    },
    "registration_datetime": "2025-01-23T13:47:57.354528",
    "expiration_date": "2026-01-23",
    "bank_account_list": [
        {
            "bank_account_key": "b6546f3b-329a-4703-addd-ac2fb34a8eea",
            "account_number": "7567236",
            "account_digit": "9",
            "account_branch": "0001",
            "financial_institution_code_number": "329",
            "financial_institution_ispb": "32402502",
            "account_type": "checking",
            "is_default": true
        }
    ],
    "signer_group_list": [
        {
            "minimum_required_signers": 1,
            "signers": [
                {
                    "name": "Jose Representante",
                    "document_number": "037.208.830-94",
                    "email": "037.208.830-94@yopmail.com",
                    "is_group_mandatory": false
                }
            ]
        }
    ],
    "issuer_representative_list": [
        {
            "name": "Jose Representante",
            "document_number": "037.208.830-94",
            "nationality": "BRA",
            "related_party_type": "partner",
            "issuer_representative_document_list": []
        }
    ],
    "issuer_contact_information_list": [
        {
            "name": "Fabrica Exemplo S.A.",
            "phone_number": "+5516282399722",
            "is_default": true,
            "email": "email@yopmail.com",
            "document_number": "96.146.194/0001-07"
        }
    ],
    "issuer_document_list": [],
    "issuer_analysis_list": [],
    "last_analysis": {
        "analysis_key": "a274106e-5dbe-4a87-8999-6e41020f09b9",
        "analysis_number": 3,
        "status": "reproved",
        "analysis_datetime": "2025-10-24 02:52:15.886432",
        "analysis_related_parties": [
            {
                "analysis_related_party_key": "e634cbb5-6b6a-42b6-9348-7cb449f646ca",
                "name": "Jose Representante",
                "document_number": "037.208.830-94",
                "analysis_roles": [
                    {
                        "related_party_type": "partner"
                    }
                ],
                "documents": [
                    {
                        "document_key": "2b8ab03b-3896-43e9-9e5a-5e3c461164ef",
                        "status": "canceled",
                        "document_type": "cnh",
                        "observation": null
                    },
                    {
                        "document_key": "77f38757-4688-4027-a19a-b7066747b3b5",
                        "status": "valid",
                        "document_type": "cnh",
                        "observation": null
                    }
                ]
            }
        ],
        "documents": [
            {
                "document_key": "0ced115e-c008-4fae-93cd-b78c3f7d384d",
                "document_type": "social_contract",
                "status": "valid",
                "observation": null
            }
        ],
        "annotations": [],
        "last_updated": "2025-10-24 02:52:20.169204",
        "analysis_origin_type": "nce_integration",
        "reproval_reason": "missing_related_parties",
        "reproval_details": "parte relacionada João Representante consta no contrato social mas não está cadastrado"
    },
    "annual_revenues": 150000,
    "is_in_national_financial_system": false
}
RESPONSE STATUS
200
Response Body com status approved
{
    "issuer_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e",
    "name": "Fabrica Exemplo S.A.",
    "document_number": "96.146.194/0001-07",
    "status": "approved",
    "backoffice_analysis_status": "approved",
    "person_type": "legal",
    "trading_name": "Fabrica Comércio",
    "cnae_code": "62.02-3-00",
    "company_type": "sa",
    "foundation_date": "2000-01-01",
    "address": {
      "street": "Rua das Empresas",
      "neighborhood": "Centro",
      "number": "123",
      "postal_code": "01001-000",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Sala 101"
    },
    "registration_datetime": "2025-01-23T13:47:57.354528",
    "expiration_date": "2026-01-23",
    "bank_account_list": [
        {
            "bank_account_key": "b6546f3b-329a-4703-addd-ac2fb34a8eea",
            "account_number": "7567236",
            "account_digit": "9",
            "account_branch": "0001",
            "financial_institution_code_number": "329",
            "financial_institution_ispb": "32402502",
            "account_type": "checking",
            "is_default": true
        }
    ],
    "signer_group_list": [
        {
            "minimum_required_signers": 1,
            "signers": [
                {
                    "name": "Jose Representante",
                    "document_number": "037.208.830-94",
                    "email": "037.208.830-94@yopmail.com",
                    "is_group_mandatory": false
                }
            ]
        }
    ],
    "issuer_representative_list": [
        {
            "name": "Jose Representante",
            "document_number": "037.208.830-94",
            "nationality": "BRA",
            "related_party_type": "partner",
            "issuer_representative_document_list": []
        }
    ],
    "issuer_contact_information_list": [
        {
            "name": "Fabrica Exemplo S.A.",
            "phone_number": "+5516282399722",
            "is_default": true,
            "email": "email@yopmail.com",
            "document_number": "96.146.194/0001-07"
        }
    ],
    "issuer_document_list": [],
    "issuer_analysis_list": [],
    "last_analysis": {
        "analysis_key": "a274106e-5dbe-4a87-8999-6e41020f09b9",
        "analysis_number": 3,
        "status": "approved",
        "analysis_datetime": "2025-10-24 02:52:15.886432",
        "analysis_related_parties": [
            {
                "analysis_related_party_key": "e634cbb5-6b6a-42b6-9348-7cb449f646ca",
                "name": "Jose Representante",
                "document_number": "037.208.830-94",
                "analysis_roles": [
                    {
                        "related_party_type": "partner"
                    }
                ],
                "documents": [
                    {
                        "document_key": "2b8ab03b-3896-43e9-9e5a-5e3c461164ef",
                        "status": "canceled",
                        "document_type": "cnh",
                        "observation": null
                    },
                    {
                        "document_key": "77f38757-4688-4027-a19a-b7066747b3b5",
                        "status": "valid",
                        "document_type": "cnh",
                        "observation": null
                    }
                ]
            }
        ],
        "documents": [
            {
                "document_key": "0ced115e-c008-4fae-93cd-b78c3f7d384d",
                "document_type": "social_contract",
                "status": "valid",
                "observation": null
            }
        ],
        "annotations": [],
        "last_updated": "2025-10-24 02:52:20.169204",
        "analysis_origin_type": "nce_integration",
        "reproval_reason": null,
        "reproval_details": null
    },
    "annual_revenues": 150000,
    "is_in_national_financial_system": false
}

Response Body Params​

CampoTipoDescriçãoMáximo de Caracteres
issuer_keystringIdentificador único do emissor.36
namestringNome completo do emissor.255
document_numberstringNúmero do documento do emissor (CNPJ).14
statusstringStatus do emissorEnumeradores status
backoffice_analysis_statusstringStatus de análise do backoffice.-
person_typestringTipo de pessoa (legal ou natural).-
trading_namestringNome fantasia do emissor.1023
cnae_codestringCódigo CNAE do emissor.10
company_typestringTipo de empresa Aceitos: ´sa´, ´ltda´, ´cop´50
foundation_datestringData de fundação do emissor.-
signer_group_listarrayLista de grupos de assinantes associados ao emissor.-
bank_account_listarrayLista de contas bancárias associadas ao emissor.-
issuer_representative_listarrayLista de representantes do emissor.-
issuer_contact_information_listarrayLista de informações de contato associadas ao emissor.-
issuer_document_listarrayLista de documentos cadastrados para o emissor.-
addressstringObjeto referenciando o endereçoObjeto address
annual_revenuesnumberDeclaração de faturamento anual do cedente.-
is_in_national_financial_systembooleanIndicador se o cedente é integrante do SFN.-
last_analysisobjectObjeto de análise.Definição de Análise.

Objeto Address​

CampoTipoDescriçãoCaracteres Máx.
streetstringNome da rua do endereço da empresa.500
neighborhoodstringNome do bairro do endereço da empresa.100
numberstringNúmero do endereço.10
postal_codestringCEP do endereço (somente números).8
citystringNome da cidade do endereço.255
statestringSigla do estado (2 caracteres).2
complementstringComplemento do endereço, se aplicável.100

Enumeradores status​

EnumDescription
in_fillingEm preenchimento
in_analysisEm análise
canceledCancelado
approvedAprovado
reprovedReprovado
expiredExpirado

Objeto payment_bank_account​

CampoTipoDescriçãoCaracteres Máx.
account_digitstringDígito da conta bancária.-
account_branchstringAgência bancária.-
account_numberstringNúmero da conta bancária.-

Definição de Análise​

CampoTipoDescriçãoCaracteres
analysis_keystringIdentificador da análise.36
analysis_numberintegerNúmero sequencial da análise.-
statusstringStatus da análise.Ver Enumeradores de status de análise.
analysis_related_partiesarrayPartes Relacionadas da análise.Ver Definição de Partes Relacionadas de Análise.
documentsarrayDocumentos da anáise.Ver Definição de Documentos de análise.
analysis_dataobjectPayload da request que originou a análise.-
analysis_datetimestringObjeto date time da criação da análise.-
reproval_reasonstringEnumerador com o motivo de rejeição da análise.Ver Enumeradores de motivo de reprovação.
reproval_detailsstringCampo livre com detalhes da rejeição da análise.-

Analysis Status​

EnumeradorDescrição
pending_documentsPendente Documentos
sent_to_analysisEnviado para Análise
pending_internal_validationEm Validação de documentos
in_manual_analysisEm Análise Manual de Compliance
approvedAprovado
reprovedReprovado

Definição de Documentos​

CampoTipoDescriçãoCaracteres
document_keystringIdentificador do documento.36
document_typestringTipo do documento.
statusstringStatus do documento.
observationstringObservações enviadas.-

Definição de Partes Relacionadas de análise​

CampoTipoDescriçãoCaracteres
analysis_related_party_keystringIdentificador da parte relacionada.36
document_numberstringNúmero de documento da parte relacionada.14 a 18
namestringNome da parte relacionada.1 a 255
documentsarrayDocumentos da anáise da parte relacionada.

Analysis Reproval Reason​

EnumDescription
assignor_updateAnálise cancelada devido à atualização cadastral posterior
insuficient_documentsDocumentação mínima para comprovação de poderes não enviada
compliance_reprovalReprovação de vínculo por análise do time de compliance
unidentified_related_partiesParte relacionada enviada, porém vinculo não comprovado
invalid_documentsDocumentação inválida/expirada
missing_related_partiesParte relacionada obrigatória não enviada