{ "openapi": "3.0.3", "info": { "title": "Consult API v3 - Serasa", "version": "3.0.0", "description": "Consultas de credito da Serasa: Relato, Credit Bureau, Concentre, CredNet, CredNet Light e Credito Basico.\n\nContrato unico de consulta.\n\nToda resposta de sucesso tem a mesma forma: `consulta` com os metadados, `dados` com os blocos canonicos e `avisos` com o que merece atencao sem ser erro. Colecao e sempre `{total, itens: []}`, data e sempre ISO-8601, valor monetario e sempre numero decimal em reais e ausencia e sempre `null`.\n\nA v1 continua no ar e congelada: nenhum produto novo entra la e o formato das respostas dela nao muda mais.\n\n## Ambiente de homologacao\n\nDa para testar a integracao inteira antes de ter contrato. Mande o header `APITOKEN: sandbox_e3e8f1d2-39fe-407b-b85a-93651c476539` e toda consulta da v3 responde com dado estatico, no mesmo envelope da resposta paga: sem chamar fornecedor, sem conferir liberacao de produto e sem cobrar nada.\n\nA resposta depende do documento consultado:\n\n| documento | tipo | cenario | o que volta |\n|---|---|---|---|\n| `11222333000181` | CNPJ | completo | resposta cheia, com todos os blocos do produto |\n| `11444777000161` | CNPJ | limpo | documento existe e nada consta |\n| `50250250000158` | CNPJ | indisponivel | devolve 502 fornecedor_indisponivel |\n| `11144477735` | CPF | completo | resposta cheia, com todos os blocos do produto |\n| `52998224725` | CPF | limpo | documento existe e nada consta |\n| `50250250284` | CPF | indisponivel | devolve 502 fornecedor_indisponivel |\n\nQualquer outro documento **valido** responde 200 com `dados` vazio e o aviso `consulta_sem_retorno` - por exemplo `12345678000195` ou `12345678909`. Documento invalido continua devolvendo 400 `documento_invalido`, para a sua validacao ser exercitada de verdade.\n\nOs produtos que nao consultam documento (localizador por nome, telefone, e-mail e endereco) tem valores proprios; veja `_docs/v3/homologacao.md`.\n\nO token e publico e tem teto de 120 requisicoes por minuto por IP; passando disso a resposta e 429 `limite_sandbox_excedido`." }, "servers": [ { "url": "https://api.consultcenter.com.br" } ], "tags": [ { "name": "catalogo", "description": "Catalogo de produtos e features liberadas para o cliente autenticado." }, { "name": "fisica", "description": "Consultas de pessoa fisica, pelo CPF." }, { "name": "juridica", "description": "Consultas de pessoa juridica, pelo CNPJ." } ], "security": [ { "ApiToken": [] } ], "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "in": "header", "name": "APITOKEN" } }, "schemas": { "Consulta": { "type": "object", "required": [ "produto", "produto_id", "documento", "tipo_pessoa", "consultado_em" ], "properties": { "produto": { "type": "string" }, "produto_id": { "type": "integer" }, "documento": { "type": "string", "description": "so digitos, sem mascara" }, "tipo_pessoa": { "type": "string", "nullable": true, "enum": [ "fisica", "juridica", null ] }, "consultado_em": { "type": "string", "format": "date-time" } } }, "Aviso": { "type": "object", "required": [ "codigo", "mensagem" ], "properties": { "codigo": { "type": "string", "enum": [ "consulta_sem_retorno", "resultado_truncado", "campo_sem_revisao", "campo_sem_mapeamento", "modelo_nao_mapeado" ] }, "mensagem": { "type": "string" }, "detalhes": { "type": "object", "additionalProperties": true } } }, "Feature": { "type": "object", "required": [ "codigo", "nome", "liberada", "preco" ], "properties": { "codigo": { "type": "string", "description": "nome do parametro na query string da consulta" }, "nome": { "type": "string", "nullable": true, "description": "nome de cadastro; null quando a feature nao tem cobranca propria" }, "liberada": { "type": "boolean", "description": "se o cliente autenticado pode usar" }, "preco": { "type": "number", "format": "double", "nullable": true, "description": "preco do plano ativo, em reais; null quando nao ha cobranca" } } }, "Erro": { "type": "object", "required": [ "erro" ], "properties": { "erro": { "type": "object", "required": [ "codigo", "mensagem" ], "properties": { "codigo": { "type": "string", "enum": [ "documento_invalido", "parametro_ausente", "parametro_invalido", "nao_autenticado", "produto_sem_acesso", "limite_mensal_excedido", "limite_sandbox_excedido", "fornecedor_indisponivel", "fornecedor_sem_resposta", "credenciais_ausentes", "credenciais_invalidas", "usuario_bloqueado", "cliente_sem_token", "configuracao_ausente" ] }, "mensagem": { "type": "string" }, "detalhes": { "type": "object", "additionalProperties": true } } } } }, "Dados_relato": { "type": "object", "properties": { "administradores": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "documento": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "nome": { "type": "string" }, "cargo": { "type": "string" }, "data_final_mandato": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "data_entrada": { "type": "string", "format": "date" }, "digito_cpf_ou_cnpj": { "type": "string" }, "nacionalidade": { "type": "string" }, "estado_civil": { "type": "string" }, "situacao_empresa": { "type": "string" }, "cargo_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "capital_social": { "type": "object", "properties": { "credor": { "type": "string" }, "natureza": { "type": "string" }, "atualizado_em": { "type": "string", "format": "date" }, "capital_social": { "type": "number", "format": "double" }, "capital_realizado": { "type": "number", "format": "double" }, "controle": { "type": "string" } } }, "cheques": { "type": "object", "properties": { "total_sustacoes_seis_meses": { "type": "integer" }, "qtd_das_ultimas_ocorrencias": { "type": "integer" }, "mensagem": { "type": "string" } } }, "consultas_anteriores": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "quantidade_consultas_por_empresas": { "type": "integer" }, "ano": { "type": "string" }, "mes": { "type": "string" }, "descricao_mes_consulta": { "type": "string" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data_consulta": { "type": "string", "format": "date" }, "qtde_consultas_no_dia": { "type": "integer" }, "cliente_consultante": { "type": "string" }, "cnpj_consultante": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" } } } } } }, "controle_societario": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "data_entrada": { "type": "string", "format": "date" }, "percentual_capital": { "type": "number", "format": "double" }, "capital_volante": { "type": "number", "format": "double" }, "tem_restricao": { "type": "boolean" }, "identificacao": { "type": "string" }, "cnpjcpf": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "cnpjcpf_doc_oficial": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "digito_cpf": { "type": "string" }, "situacao_empresa": { "type": "string" }, "pais_origem": { "type": "string" } } } } } }, "faturamento_presumido": { "type": "object", "properties": { "data_atualizacao": { "type": "string", "format": "date" }, "data_consulta": { "type": "string", "format": "date" }, "valor_anual": { "type": "number", "format": "double" }, "hora_consulta": { "type": "string" } } }, "historico_pagamentos": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "quantidade_periodo_de": { "type": "integer" }, "quantidade_periodo_ate": { "type": "integer" }, "percentual_periodo_de": { "type": "number", "format": "double" }, "percentual_periodo_ate": { "type": "number", "format": "double" }, "periodo": { "type": "string" }, "descricao_periodo": { "type": "string" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "descricao_faixa_quantidade_periodo": { "type": "string" }, "codigo_faixa_quantidade_periodo": { "type": "string" } } } } } }, "historico_pagamentos_comercial": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data_ultima_atualizacao": { "type": "string", "format": "date" }, "data_potencial": { "type": "string", "format": "date" }, "data": { "type": "string", "format": "date" }, "quantidade_fontes_informacoes": { "type": "integer" }, "quantidade_fontes_evolucao": { "type": "integer" }, "quantidade_fontes_referenciais": { "type": "integer" }, "quantidade_fontes_relacionamento": { "type": "integer" }, "quantidade_fontes_pagamento_a_vista": { "type": "integer" }, "quantidade_fontes_historico": { "type": "integer" }, "valor_potencial_de": { "type": "number", "format": "double" }, "valor_pagamento_de": { "type": "number", "format": "double" }, "valor_potencial_ate": { "type": "number", "format": "double" }, "valor_pagamento_ate": { "type": "number", "format": "double" }, "percentual_pagamento_de": { "type": "number", "format": "double" }, "percentual_pagamento_ate": { "type": "number", "format": "double" }, "valor_faixa_media_potencial_de": { "type": "number", "format": "double" }, "valor_faixa_media_potencial_ate": { "type": "number", "format": "double" }, "mensagem_retorno": { "type": "string" }, "descricao": { "type": "string" }, "descricao_periodo_relacionamento": { "type": "string" }, "descricao_periodo_historico_pagamentos": { "type": "string" }, "nome_fonte_informacao": { "type": "string" }, "descricao_negocio": { "type": "string" }, "ano_compromisso": { "type": "string" }, "mes_compromisso": { "type": "string" }, "ano_pagamento": { "type": "string" }, "mes_pagamento": { "type": "string" }, "descricao_mes_pagamento": { "type": "string" }, "descricao_faixa_valor_potencial": { "type": "string" }, "valor_potencial": { "type": "string" }, "descricao_faixa": { "type": "string" }, "cnpj_fonte": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "descricao_faixa_media_potencial": { "type": "string" }, "media_potencial": { "type": "string" }, "filial": { "type": "string" }, "digito_controle_cnpj": { "type": "string" }, "prazo_medio_atraso_de": { "type": "string" }, "prazo_medio_atraso_ate": { "type": "string" }, "codigo_faixa_valor_potencial": { "type": "string" }, "codigo_valor": { "type": "string" }, "codigo_faixa": { "type": "string" }, "codigo_faixa_a_vencer": { "type": "string" }, "codigo_faixa_media_potencial": { "type": "string" }, "codigo_media": { "type": "string" }, "segmento_origem_informacao": { "type": "string" } } } } } }, "identificacao": { "type": "object", "properties": { "razao_social": { "type": "string" }, "situacao_cadastral": { "type": "string" }, "data_fundacao": { "type": "string", "format": "date" }, "fax": { "type": "integer" }, "qtde_empregados": { "type": "integer" }, "percentual_compra": { "type": "number", "format": "double" }, "percentual_vendas": { "type": "number", "format": "double" }, "qtde_filiais": { "type": "integer" }, "numero_inscricao_no_registro_empresas": { "type": "integer" }, "tp_inf_2_identificacao": { "type": "string" }, "mensagem_status_empresa": { "type": "string" }, "cidade": { "type": "string" }, "ramo": { "type": "string" }, "uf": { "type": "string" }, "cep": { "type": "string" }, "ddd": { "type": "string" }, "telefone": { "type": "string" }, "site": { "type": "string" }, "bairro": { "type": "string" }, "cnpj_empresa": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "nome_fantasia_empresa": { "type": "string" }, "cnae": { "type": "string" }, "endereco": { "type": "string" }, "descricao_tipo_sociedade": { "type": "string" }, "area_reservada": { "type": "string" }, "situacao_cadastral_origem": { "type": "string", "description": "codigo cru do fornecedor" }, "codigo_atividade_serasa": { "type": "string" } } }, "indice_mercado": { "type": "object", "properties": { "mensagem": { "type": "string" } } }, "limite_credito": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "hora": { "type": "string" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "mensagem": { "type": "string" } } } } } }, "orgaos_publicos": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "modalidade": { "type": "string" }, "data_atualizacao": { "type": "string", "format": "date" }, "data_vencimento": { "type": "string", "format": "date" }, "total": { "type": "integer" }, "total_das_anotacoes": { "type": "number", "format": "double" }, "valor_anotacao": { "type": "number", "format": "double" }, "avalista": { "type": "boolean" }, "hora_atualizacao": { "type": "string" }, "origem_anotacao": { "type": "string" }, "mensagem_retorno": { "type": "string" }, "sigla_estado": { "type": "string" }, "contrato_anotacao": { "type": "string" }, "modalidade_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "pendencias_financeiras": { "type": "object", "properties": { "credor": { "type": "string" }, "contrato": { "type": "string" }, "ultima_ocorrencia": { "type": "string", "format": "date" }, "data": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "total": { "type": "integer" }, "valor": { "type": "number", "format": "double" }, "valor_total": { "type": "number", "format": "double" }, "avalista": { "type": "boolean" }, "mensagem": { "type": "string" }, "tipo": { "type": "string" }, "filial_ocorrencia": { "type": "string" } } }, "pontualidade_pagamentos": { "type": "object", "properties": { "pontualiade_pagamentos": { "type": "integer" }, "codigo": { "type": "string" }, "texto": { "type": "string" } } }, "relacionamento_mais_antigo": { "type": "object", "properties": { "mes": { "type": "string" }, "ano": { "type": "string" } } }, "resumo_concentre": { "type": "object", "properties": { "credor": { "type": "string" }, "quantidade": { "type": "integer" }, "ano_inicial": { "type": "integer" }, "valor": { "type": "number", "format": "double" }, "valor_total": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "ocorrencia": { "type": "string" }, "mes_inicial": { "type": "string" }, "mes_inicial_ocorrencia": { "type": "string" }, "mes_final": { "type": "string" }, "mes_final_ocorrencia": { "type": "string" }, "ano_final": { "type": "string" }, "moeda": { "type": "string" }, "agencia_ocorrencia": { "type": "string" } } }, "risco_setor": { "type": "object", "properties": { "data_consulta": { "type": "string", "format": "date" }, "valor_prinad": { "type": "number", "format": "double" }, "hora_consulta": { "type": "string" }, "fator_scoring_pj": { "type": "string" } } }, "score": { "type": "object", "properties": { "probabilidade_inadimplencia": { "type": "number", "format": "double" }, "fator_riskscoring": { "type": "string" } } }, "socios": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data_atualizacao": { "type": "string", "format": "date" }, "data_emissao_rg": { "type": "string", "format": "date" }, "documento_socio": { "type": "string" }, "filial_documento": { "type": "string" }, "digito_documento": { "type": "string" }, "nome_socio": { "type": "string" }, "numero_rg_socio": { "type": "string" }, "vinculo_socio_com_a_empresa": { "type": "string" }, "estado": { "type": "string" }, "ddd_telefone": { "type": "string" }, "numero_telefone": { "type": "string" }, "ramal": { "type": "string" }, "nome_logradouro": { "type": "string" }, "bairro": { "type": "string" }, "cidade": { "type": "string" }, "estado_endereco": { "type": "string" }, "numero_celular": { "type": "string" }, "tempo_residencia": { "type": "string" } } } } } } } }, "Dados_credit_bureau": { "type": "object", "properties": { "alertas": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data_ocorrencia": { "type": "string", "format": "date" }, "data": { "type": "string", "format": "date" }, "total_cheques_devolvidos": { "type": "integer" }, "valor_cheque_devolvido": { "type": "number", "format": "double" }, "total": { "type": "integer" }, "registro_b360_detalhe_cheque_sem_fundos_bp24": { "type": "string" }, "mensagem_retorno_nao_calculo": { "type": "string" }, "mensagem": { "type": "string" }, "numero_cheque": { "type": "string" }, "alinea_devolucao_cheque": { "type": "string" }, "tipo_moeda": { "type": "string" }, "banco": { "type": "string" }, "uso_reservado_serasa": { "type": "string" }, "agencia": { "type": "string" }, "cidade": { "type": "string" }, "estado": { "type": "string" }, "tipo_conta": { "type": "string" }, "numero_conta_corrente": { "type": "string" }, "filler": { "type": "string" } } } } } }, "consultas_anteriores": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "data_ultima_atualizacao": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "total_consultas_credito": { "type": "integer" }, "total_consultas_a_cheques": { "type": "integer" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "empresa": { "type": "string" }, "data": { "type": "string", "format": "date" } } } } } }, "identificacao": { "type": "object", "properties": { "nome": { "type": "string" }, "nome_mae": { "type": "string" }, "cpf": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "data_ultima_alteracao_cadastral": { "type": "string", "format": "date" }, "data_nascimento_informada_pela_empresa": { "type": "string", "format": "date" }, "cidade_nascimento": { "type": "string", "format": "date" }, "uf_nascimento": { "type": "string", "format": "date" }, "data_nascimento": { "type": "string", "format": "date" }, "atualizado_em": { "type": "string", "format": "date" }, "data_emissao": { "type": "string", "format": "date" }, "numero_dependentes": { "type": "integer" }, "estado_civil": { "type": "string" }, "escolaridade": { "type": "string" }, "sigla_estado_nascimento": { "type": "string" }, "cpf_conjuge": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "ddd_telefone_residencial": { "type": "string" }, "sexo": { "type": "string" }, "nome_tipo_documento_identificacao": { "type": "string" }, "telefone_residencial": { "type": "string" }, "ddd": { "type": "string" }, "ddd_telefone_comercial": { "type": "string" }, "cidade": { "type": "string" }, "telefone_comercial": { "type": "string" }, "rg": { "type": "string" }, "telefone": { "type": "string" }, "ramal_telefone_comercial": { "type": "string" }, "telefone_celular": { "type": "string" }, "numero_telefone_celular": { "type": "string" }, "orgao": { "type": "string" }, "situacao_cpf_receita_federal": { "type": "string" }, "ddd_celular": { "type": "string" }, "sigla_estado_orgao_emissor_documento": { "type": "string" } } }, "mensagens": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "mais_antiga": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mais_recente": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "total": { "type": "integer" }, "valor_ultima_ocorrencia": { "type": "number", "format": "double" }, "registro_b359_resumo_cheque_sem_fundo_bx20": { "type": "string" }, "descricao_tipo_ocorrencia": { "type": "string" }, "mensagem": { "type": "string" }, "tipo_moeda_tabela_10": { "type": "string" }, "banco": { "type": "string" }, "agencia_banco": { "type": "string" }, "filler": { "type": "string" } } } } } }, "score": { "type": "object", "properties": { "pontuacao": { "type": "integer" }, "probabilidade_inadimplencia": { "type": "number", "format": "double" }, "descricao_scoring_escolhido": { "type": "string" }, "nome_das_faixas": { "type": "string" } } } } }, "Dados_concentre_pf": { "type": "object", "properties": { "consultas_anteriores": { "type": "object", "properties": { "competencia": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mes_1": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mes_2": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mes_3": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mes_4": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "quantidade_1": { "type": "integer" }, "quantidade_2": { "type": "integer" }, "quantidade_3": { "type": "integer" }, "quantidade_4": { "type": "integer" }, "quantidade": { "type": "integer" } } }, "identificacao": { "type": "object", "properties": { "nome": { "type": "string" }, "nome_mae": { "type": "string" }, "situacao_cadastral": { "type": "string" }, "data_nascimento": { "type": "string", "format": "date" }, "atualizado_em": { "type": "string", "format": "date" }, "situacao_cadastral_origem": { "type": "string", "description": "codigo cru do fornecedor" } } }, "participacoes": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "empresa": { "type": "string" }, "cnpj": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "desde": { "type": "string", "format": "date" }, "atualizado_em": { "type": "string", "format": "date" }, "participacao": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "uf": { "type": "string" } } } } } }, "score": { "type": "object", "properties": { "data_referencia": { "type": "string", "format": "date" }, "pontuacao": { "type": "integer" }, "probabilidade_inadimplencia": { "type": "number", "format": "double" }, "mensagem": { "type": "string" } } } } }, "Dados_concentre_pj": { "type": "object", "properties": { "administradores": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "documento": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "nome": { "type": "string" }, "cargo": { "type": "string" }, "tem_restricao": { "type": "boolean" }, "cargo_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "consultas_anteriores": { "type": "object", "properties": { "competencia": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "quantidade": { "type": "integer" } } }, "identificacao": { "type": "object", "properties": { "razao_social": { "type": "string" }, "nome_fantasia": { "type": "string" }, "situacao_cadastral": { "type": "string" }, "data_fundacao": { "type": "string", "format": "date" }, "atualizado_em": { "type": "string", "format": "date" }, "uf": { "type": "string" }, "municipio": { "type": "string" }, "situacao_cadastral_origem": { "type": "string", "description": "codigo cru do fornecedor" } } }, "limite_credito": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "mensagem": { "type": "string" } } } } } }, "score": { "type": "object", "properties": { "data_consulta": { "type": "string", "format": "date" }, "pontuacao": { "type": "integer" }, "probabilidade_inadimplencia": { "type": "number", "format": "double" }, "hora_consulta": { "type": "string" }, "mensagem": { "type": "string" } } }, "socios": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "documento": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "nome": { "type": "string" }, "percentual_capital": { "type": "number", "format": "double" } } } } } } } }, "Dados_crednet_pf": { "type": "object", "properties": { "acoes_judiciais": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "natureza": { "type": "string" }, "data": { "type": "string", "format": "date" }, "vara": { "type": "integer" }, "distr": { "type": "integer" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "uf": { "type": "string" }, "cidade": { "type": "string" } } } } } }, "alertas": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "sequencia": { "type": "integer" }, "documento": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "tipo_documento": { "type": "string" }, "data_ocorrencia": { "type": "string", "format": "date" }, "total": { "type": "integer" }, "mensagem": { "type": "string" }, "motivo_ocorrencia": { "type": "string" } } } } } }, "cheques": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data_ocorrencia": { "type": "string", "format": "date" }, "quantidade_ccf_para_o_banco": { "type": "integer" }, "valor_total_cheque": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "numero_cheque": { "type": "string" }, "alinea_cheque": { "type": "string" }, "nome_banco": { "type": "string" }, "numero_agencia": { "type": "string" }, "cidade_agencia": { "type": "string" }, "uf_agencia": { "type": "string" } } } } } }, "comprometimento_renda": { "type": "object", "properties": { "mensagem": { "type": "string" } } }, "consultas_anteriores": { "type": "object", "properties": { "ultimos_15_dias": { "type": "integer" }, "de_16_a_30_dias": { "type": "integer" }, "de_31_a_60_dias": { "type": "integer" }, "de_61_a_90_dias": { "type": "integer" }, "mensagem": { "type": "string" } } }, "falencias": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data_ocorrencia": { "type": "string", "format": "date" }, "data_inclusao_anotacao": { "type": "string", "format": "date" }, "mensagem": { "type": "string" }, "numero_vara_civel": { "type": "string" }, "sigla_unidade_federacao": { "type": "string" }, "nome_cidade": { "type": "string" }, "numero_filial_cnpj_consultado": { "type": "string" }, "digito_verificador_documento_consultado": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "hora_inclusao_anotacao": { "type": "string" }, "descricao_natureza": { "type": "string" }, "codigo_natureza": { "type": "string" }, "codigo_praca_embratel": { "type": "string" } } } } } }, "historico_pagamentos": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "periodo_dias": { "type": "string" }, "mensagem": { "type": "string" } } } } } }, "identificacao": { "type": "object", "properties": { "nome": { "type": "string" }, "nome_mae": { "type": "string" }, "situacao_cadastral": { "type": "string" }, "data_nascimento": { "type": "string", "format": "date" }, "atualizado_em": { "type": "string", "format": "date" }, "situacao_cadastral_origem": { "type": "string", "description": "codigo cru do fornecedor" } } }, "indice_mercado": { "type": "object", "properties": { "mensagem": { "type": "string" } } }, "participacoes": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "empresa": { "type": "string" }, "cnpj": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "desde": { "type": "string", "format": "date" }, "atualizado_em": { "type": "string", "format": "date" }, "participacao": { "type": "number", "format": "double" }, "tem_restricao": { "type": "boolean" }, "mensagem": { "type": "string" }, "uf": { "type": "string" } } } } } }, "participacoes_insucesso": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data_ocorrencia": { "type": "string", "format": "date" }, "data_inclusao_anotacao": { "type": "string", "format": "date" }, "mensagem": { "type": "string" }, "numero_vara_civel": { "type": "string" }, "cnpj_empresa_em_que_participa": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "nome_empresa_em_que_participa": { "type": "string" }, "numero_filial_cnpj_consultado": { "type": "string" }, "digito_verificador_documento_consultado": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "hora_inclusao_anotacao": { "type": "string" }, "codigo_natureza": { "type": "string" }, "codigo_qualificacao": { "type": "string" } } } } } }, "pendencias_financeiras": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer" }, "tipo_anotacao": { "type": "string" }, "mais_antiga": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mais_recente": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "valor_total": { "type": "number", "format": "double" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "empresa": { "type": "string" }, "modalidade": { "type": "string" }, "contrato": { "type": "string" }, "tipo_anotacao": { "type": "string" }, "data_ocorrencia": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "avalista": { "type": "boolean" }, "mensagem": { "type": "string" }, "praca": { "type": "string" }, "modalidade_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "pendencias_internas": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "credor": { "type": "string" }, "modalidade": { "type": "string" }, "contrato": { "type": "string" }, "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "uf": { "type": "string" }, "modalidade_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "protestos": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "cartorio": { "type": "string" }, "cidade": { "type": "string" }, "uf": { "type": "string" } } } } } }, "recuperacao_credito": { "type": "object", "properties": { "classe_collection": { "type": "string" }, "mensagem": { "type": "string" } } }, "renda_estimada": { "type": "object", "properties": { "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" } } }, "score": { "type": "object", "properties": { "pontuacao": { "type": "integer" }, "probabilidade_inadimplencia": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "taxa_estimada_inadimplencia": { "type": "string" }, "classe_intervalar": { "type": "string" } } } } }, "Dados_crednet_pj": { "type": "object", "properties": { "administradores": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "cpf": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "nome": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "cargo": { "type": "string" }, "consistido": { "type": "string" }, "tem_restricao": { "type": "boolean" }, "tipo_pessoa_origem": { "type": "string", "description": "codigo cru do fornecedor" }, "cargo_origem": { "type": "string", "description": "codigo cru do fornecedor" }, "consistido_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "alertas": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "sequencia": { "type": "integer" }, "documento": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "tipo_documento": { "type": "string" }, "data_ocorrencia": { "type": "string", "format": "date" }, "total": { "type": "integer" }, "mensagem": { "type": "string" }, "motivo_ocorrencia": { "type": "string" } } } } } }, "cheques": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer" }, "mais_antiga": { "type": "string", "format": "date" }, "mais_recente": { "type": "string", "format": "date" }, "numero_banco": { "type": "string" }, "agencia": { "type": "string" }, "instituicao": { "type": "string" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "ocorrencia_mais_recente": { "type": "string", "format": "date" }, "total": { "type": "integer" }, "valor_total": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "numero_cheque": { "type": "string" }, "alinea_cheque": { "type": "string" }, "numero_banco": { "type": "string" }, "instituicao": { "type": "string" }, "agencia": { "type": "string" }, "cidade": { "type": "string" }, "uf": { "type": "string" } } } } } }, "consultas_anteriores": { "type": "object", "properties": { "ultimos_15_dias": { "type": "integer" }, "de_16_a_30_dias": { "type": "integer" }, "de_31_a_60_dias": { "type": "integer" }, "de_61_a_90_dias": { "type": "integer" }, "mensagem": { "type": "string" } } }, "faturamento_presumido": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "valor_anual": { "type": "number", "format": "double" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "interpretacao": { "type": "string" } } } } } }, "historico_pagamentos_comercial": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "valor_inicial_faixa_valor": { "type": "number", "format": "double" }, "valor_final_faixa_valor": { "type": "number", "format": "double" }, "percentual_pontual": { "type": "number", "format": "double" }, "percentual_a_vista": { "type": "number", "format": "double" }, "percentual_em_atraso": { "type": "number", "format": "double" }, "percentual_parcelado": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "codigo_classificacao_faixa": { "type": "string" } } } } } }, "historico_pagamentos_financeiro": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "percentual_das_parcelas_pagas": { "type": "number", "format": "double" }, "percentual_das_parcelas_a_vencer": { "type": "number", "format": "double" }, "percentual_das_parcelas_em_aberto": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "valor_total_compromissos": { "type": "string" }, "valor_total_pago_contratos_ativos": { "type": "string" }, "percentual_pontualidade_pagamento_rotativo": { "type": "string" }, "quantidade_compromissos": { "type": "string" }, "percentual_pagamentos_parcelados_pontual": { "type": "string" }, "percentual_pagamentos_parcelados_em_atraso": { "type": "string" }, "codigo_faixa_total_compromissos": { "type": "string" }, "codigo_faixa_total_pago_contratos_ativos": { "type": "string" }, "codigo_faixa_quantidade_compromissos": { "type": "string" } } } } } }, "identificacao": { "type": "object", "properties": { "razao_social": { "type": "string" }, "situacao_cadastral": { "type": "string" }, "data_fundacao": { "type": "string", "format": "date" }, "atualizado_em": { "type": "string", "format": "date" }, "situacao_cadastral_origem": { "type": "string", "description": "codigo cru do fornecedor" } } }, "indice_mercado": { "type": "object", "properties": { "mensagem": { "type": "string" } } }, "limite_credito": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "valor": { "type": "number", "format": "double" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "mensagem": { "type": "string" } } } } } }, "participacoes": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "cnpj": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "documento": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "empresa": { "type": "string" }, "vinculo": { "type": "string" }, "percentual_capital": { "type": "number", "format": "double" }, "participante": { "type": "string" }, "cidade": { "type": "string" }, "uf": { "type": "string" } } } } } }, "pendencias_financeiras": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer" }, "tipo_anotacao": { "type": "string" }, "mais_antiga": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mais_recente": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "valor_total": { "type": "number", "format": "double" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "empresa": { "type": "string" }, "modalidade": { "type": "string" }, "contrato": { "type": "string" }, "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "avalista": { "type": "boolean" }, "mensagem": { "type": "string" }, "praca": { "type": "string" }, "modalidade_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "pendencias_internas": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer" }, "data_ocorrencia_mais_antiga": { "type": "string", "format": "date" }, "data_ocorrencia_mais_recente": { "type": "string", "format": "date" }, "valor_total": { "type": "number", "format": "double" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "credor": { "type": "string" }, "modalidade": { "type": "string" }, "contrato": { "type": "string" }, "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "uf": { "type": "string" }, "reservado": { "type": "string" }, "modalidade_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "pontualidade_pagamentos": { "type": "object", "properties": { "pontuacao": { "type": "integer" }, "mensagem": { "type": "string" } } }, "protestos": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer" }, "mais_antiga": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mais_recente": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "valor_total": { "type": "number", "format": "double" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "cartorio": { "type": "string" }, "cidade": { "type": "string" }, "uf": { "type": "string" } } } } } }, "score": { "type": "object", "properties": { "pontuacao": { "type": "integer" }, "mensagem": { "type": "string" } } }, "socios": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "documento": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "nome": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "consistido": { "type": "string" }, "situacao_capital_total": { "type": "string" }, "percentual_capital": { "type": "number", "format": "double" }, "tem_restricao": { "type": "boolean" }, "mensagem": { "type": "string" }, "tipo_pessoa_origem": { "type": "string", "description": "codigo cru do fornecedor" }, "consistido_origem": { "type": "string", "description": "codigo cru do fornecedor" }, "situacao_capital_total_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } } } }, "Dados_crednet_light_pf": { "type": "object", "properties": { "acoes_judiciais": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "natureza": { "type": "string" }, "data": { "type": "string", "format": "date" }, "vara": { "type": "integer" }, "distr": { "type": "integer" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "uf": { "type": "string" }, "cidade": { "type": "string" } } } } } }, "alertas": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "sequencia": { "type": "integer" }, "documento": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "tipo_documento": { "type": "string" }, "data_ocorrencia": { "type": "string", "format": "date" }, "total_mensagem": { "type": "integer" }, "mensagem": { "type": "string" }, "motivo_ocorrencia": { "type": "string" } } } } } }, "cheques": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "cheque_no": { "type": "integer" }, "alinea": { "type": "integer" }, "qtde": { "type": "integer" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "banco": { "type": "string" }, "agencia": { "type": "string" }, "cidade": { "type": "string" } } } } } }, "consultas_anteriores": { "type": "object", "properties": { "ultimos_15_dias": { "type": "integer" }, "de_16_a_30_dias": { "type": "integer" }, "de_31_a_60_dias": { "type": "integer" }, "de_61_a_90_dias": { "type": "integer" }, "mensagem": { "type": "string" } } }, "falencias": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data_ocorrencia": { "type": "string", "format": "date" }, "data_inclusao_anotacao": { "type": "string", "format": "date" }, "mensagem": { "type": "string" }, "numero_vara_civel": { "type": "string" }, "sigla_unidade_federacao": { "type": "string" }, "nome_cidade": { "type": "string" }, "numero_filial_cnpj_consultado": { "type": "string" }, "digito_verificador_documento_consultado": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "hora_inclusao_anotacao": { "type": "string" }, "descricao_natureza": { "type": "string" }, "codigo_natureza": { "type": "string" }, "codigo_praca_embratel": { "type": "string" } } } } } }, "identificacao": { "type": "object", "properties": { "nome": { "type": "string" }, "nome_mae": { "type": "string" }, "situacao_cadastral": { "type": "string" }, "data_nascimento": { "type": "string", "format": "date" }, "atualizado_em": { "type": "string", "format": "date" }, "situacao_cadastral_origem": { "type": "string", "description": "codigo cru do fornecedor" } } }, "participacoes_insucesso": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data_ocorrencia": { "type": "string", "format": "date" }, "data_inclusao_anotacao": { "type": "string", "format": "date" }, "mensagem": { "type": "string" }, "numero_vara_civel": { "type": "string" }, "cnpj_empresa_em_que_participa": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "nome_empresa_em_que_participa": { "type": "string" }, "numero_filial_cnpj_consultado": { "type": "string" }, "digito_verificador_documento_consultado": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "hora_inclusao_anotacao": { "type": "string" }, "codigo_natureza": { "type": "string" }, "codigo_qualificacao": { "type": "string" } } } } } }, "pendencias_financeiras": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer" }, "tipo_anotacao": { "type": "string" }, "mais_antiga": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mais_recente": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "valor_total": { "type": "number", "format": "double" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "credor": { "type": "string" }, "modalidade": { "type": "string" }, "contrato": { "type": "string" }, "tipo_anotacao": { "type": "string" }, "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "avalista": { "type": "boolean" }, "praca": { "type": "string" }, "modalidade_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "pendencias_internas": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "credor": { "type": "string" }, "modalidade": { "type": "string" }, "contrato": { "type": "string" }, "data_ocorrencia": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "avalista": { "type": "boolean" }, "mensagem": { "type": "string" }, "tipo_moeda": { "type": "string" }, "sigla_embratel_praca_ocorrencia": { "type": "string" }, "modalidade_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "protestos": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "cartorio": { "type": "string" }, "cidade": { "type": "string" }, "uf": { "type": "string" } } } } } }, "score": { "type": "object", "properties": { "pontuacao": { "type": "integer" }, "probabilidade_inadimplencia": { "type": "number", "format": "double" }, "mensagem": { "type": "string" } } } } }, "Dados_crednet_light_pj": { "type": "object", "properties": { "alertas": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "sequencia": { "type": "integer" }, "documento": { "type": "string", "pattern": "^[0-9]{11}$|^[0-9]{14}$" }, "tipo_documento": { "type": "string" }, "data_ocorrencia": { "type": "string", "format": "date" }, "total_mensagem": { "type": "integer" }, "mensagem": { "type": "string" }, "motivo_ocorrencia": { "type": "string" } } } } } }, "cheques": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "no_cheque": { "type": "integer" }, "alinea": { "type": "integer" }, "quantidade": { "type": "integer" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "banco": { "type": "string" }, "agencia": { "type": "string" }, "cidade": { "type": "string" } } } } } }, "consultas_anteriores": { "type": "object", "properties": { "ultimos_15_dias": { "type": "integer" }, "de_16_a_30_dias": { "type": "integer" }, "de_31_a_60_dias": { "type": "integer" }, "de_61_a_90_dias": { "type": "integer" }, "mensagem": { "type": "string" } } }, "identificacao": { "type": "object", "properties": { "nome_mae": { "type": "string" }, "razao_social": { "type": "string" }, "situacao_cadastral": { "type": "string" }, "data_fundacao": { "type": "string", "format": "date" }, "atualizado_em": { "type": "string", "format": "date" }, "situacao_cadastral_origem": { "type": "string", "description": "codigo cru do fornecedor" } } }, "limite_credito": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "valor": { "type": "number", "format": "double" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "mensagem": { "type": "string" } } } } } }, "pendencias_financeiras": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer" }, "tipo_anotacao": { "type": "string" }, "mais_antiga": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "mais_recente": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}$" }, "valor_total": { "type": "number", "format": "double" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "credor": { "type": "string" }, "modalidade": { "type": "string" }, "contrato": { "type": "string" }, "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "avalista": { "type": "boolean" }, "mensagem": { "type": "string" }, "praca": { "type": "string" }, "modalidade_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "pendencias_internas": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "credor": { "type": "string" }, "modalidade": { "type": "string" }, "contrato": { "type": "string" }, "data_ocorrencia": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "avalista": { "type": "boolean" }, "mensagem": { "type": "string" }, "tipo_moeda": { "type": "string" }, "sigla_embratel_praca_ocorrencia": { "type": "string" }, "modalidade_origem": { "type": "string", "description": "codigo cru do fornecedor" } } } } } }, "protestos": { "type": "object", "required": [ "total", "itens" ], "properties": { "total": { "type": "integer", "description": "quantidade de itens; 0 quando nada consta" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "valor": { "type": "number", "format": "double" }, "mensagem": { "type": "string" }, "cartorio": { "type": "string" }, "cidade": { "type": "string" }, "uf": { "type": "string" } } } } } }, "score": { "type": "object", "properties": { "classe_score": { "type": "string" }, "mensagem": { "type": "string" } } } } }, "Dados_credito_basico_pf": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de SerasaRestAdapter.", "additionalProperties": true }, "Dados_credito_basico_pj": { "type": "object", "description": "Blocos canonicos montados pelo adaptador de SerasaRestAdapter.", "additionalProperties": true } } }, "paths": { "/v3/consultas": { "get": { "summary": "Lista as consultas disponiveis", "description": "So aparecem os produtos liberados para o cliente autenticado (`acessos`). Com `app=1`, apenas os habilitados no app interno (`product.appAccess`); sem o parametro, tudo que o cliente tem acesso.", "operationId": "catalogo", "tags": [ "catalogo" ], "parameters": [ { "name": "app", "in": "query", "required": false, "description": "1 = so os produtos habilitados no app interno; 0 ou ausente = todos", "schema": { "type": "string", "enum": [ "0", "1" ] } } ], "responses": { "200": { "description": "Catalogo de produtos, parametros e features" } } } }, "/v3/consultas/relato": { "get": { "summary": "Consulta relato", "operationId": "consultar_relato", "tags": [ "juridica" ], "parameters": [ { "name": "cnpj", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "quadro_social", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "fat_presum", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "limite_pj", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "renda_estimada", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "indic_mercad", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "risco_setor", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "part_soc", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "pontualidade", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "hist_pos_com", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "org_publicos", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_relato" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "relato", "produto_id": 4043, "documento": "11222333000181", "tipo_pessoa": "juridica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "administradores": { "total": 2, "itens": [ { "nome": "MARIA SOUZA COMERCIO LTDA", "cargo": "AMOSTRA", "data_final_mandato": "2023-12", "data_entrada": "2023-04-15", "nacionalidade": "EXEMPLO", "estado_civil": "DEMONSTRA", "situacao_empresa": "07" }, { "nome": "MARIA SOUZA COMERCIO LTDA", "cargo": "DEMONSTRACAO", "data_final_mandato": "2025-06", "data_entrada": "2022-01-18", "nacionalidade": "HOMOLOGACAO", "estado_civil": "EXEMPLO", "situacao_empresa": "06" } ] }, "capital_social": { "credor": "COMERCIO EXE", "natureza": "AMOSTRA", "atualizado_em": "2025-07-30", "capital_social": 480000, "capital_realizado": 1500, "controle": "HOMOLOGACAO" }, "cheques": { "total_sustacoes_seis_meses": 47, "qtd_das_ultimas_ocorrencias": 128, "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "consultas_anteriores": { "total": 2, "quantidade_consultas_por_empresas": 128, "ano": "XX", "mes": "XX", "descricao_mes_consulta": "XXX", "itens": [ { "data_consulta": "2024-09-02", "qtde_consultas_no_dia": 128, "cliente_consultante": "DEMONSTRACAO" }, { "data_consulta": "2023-04-15", "qtde_consultas_no_dia": 675, "cliente_consultante": "EXEMPLO" } ] }, "controle_societario": { "total": 2, "itens": [ { "nome": "MARIA SOUZA COMERCIO LTDA", "data_entrada": "2023-04-15", "percentual_capital": 875, "capital_volante": 4500, "tem_restricao": true, "identificacao": "J", "cnpjcpf_doc_oficial": "0099", "situacao_empresa": "07", "pais_origem": "AMOSTRA" }, { "nome": "MARIA SOUZA COMERCIO LTDA", "data_entrada": "2022-01-18", "percentual_capital": 4500, "capital_volante": 220, "tem_restricao": true, "identificacao": "F", "situacao_empresa": "06", "pais_origem": "DEMONSTRACAO" } ] }, "faturamento_presumido": { "data_atualizacao": "2023-04-15", "data_consulta": "2024-09-02", "valor_anual": 23750000, "hora_consulta": "HOMOLO" }, "historico_pagamentos": { "total": 8, "itens": [ { "periodo": "AMOSTRA", "codigo": "XXX", "descricao": "AMOSTRA" }, { "periodo": "DEMONSTRACAO", "codigo": "XXX", "descricao": "DEMONSTRACAO" }, { "periodo": "EXEMPLO", "codigo": "XXX", "descricao": "HOMOLOGACAO" }, { "periodo": "HOMOLOGACAO", "codigo": "XXX", "descricao": "AMOSTRA" }, { "descricao_periodo": "AMOSTRA", "descricao_faixa_quantidade_periodo": "AMOSTRA", "codigo_faixa_quantidade_periodo": "XXX" }, { "descricao_periodo": "DEMONSTRACAO", "descricao_faixa_quantidade_periodo": "DEMONSTRACAO", "codigo_faixa_quantidade_periodo": "XXX" }, { "quantidade_periodo_de": 12, "quantidade_periodo_ate": 128, "percentual_periodo_de": 12.34, "percentual_periodo_ate": 45, "descricao_periodo": "EXEMPLO", "descricao_faixa_quantidade_periodo": "HOMOLOGACAO", "codigo_faixa_quantidade_periodo": "XXX" }, { "quantidade_periodo_de": 47, "quantidade_periodo_ate": 675, "percentual_periodo_de": 8.75, "percentual_periodo_ate": 2.2, "descricao_periodo": "HOMOLOGACAO", "descricao_faixa_quantidade_periodo": "AMOSTRA", "codigo_faixa_quantidade_periodo": "XXX" } ] }, "historico_pagamentos_comercial": { "total": 22, "itens": [ { "nome_fonte_informacao": "HOMOLOGACAO", "filial": "EXEM" }, { "nome_fonte_informacao": "AMOSTRA", "filial": "HOMO" }, { "data_ultima_atualizacao": "2025-07-30" }, { "data_ultima_atualizacao": "2024-09-02" }, { "mensagem_retorno": "EXEMPLO" }, { "mensagem_retorno": "HOMOLOGACAO" }, { "valor_pagamento_de": 23750, "valor_pagamento_ate": 1500, "percentual_pagamento_de": 12.34, "percentual_pagamento_ate": 45, "descricao_periodo_historico_pagamentos": "HOMOLOGACAO", "ano_pagamento": "XX", "mes_pagamento": "XX", "descricao_mes_pagamento": "XXX", "descricao_faixa": "DEMONSTRACAO", "prazo_medio_atraso_de": "XXX", "prazo_medio_atraso_ate": "XXX", "codigo_faixa": "XXX" }, { "valor_pagamento_de": 480000, "valor_pagamento_ate": 23750, "percentual_pagamento_de": 8.75, "percentual_pagamento_ate": 2.2, "descricao_periodo_historico_pagamentos": "AMOSTRA", "ano_pagamento": "XX", "mes_pagamento": "XX", "descricao_mes_pagamento": "XXX", "descricao_faixa": "EXEMPLO", "prazo_medio_atraso_de": "XXX", "prazo_medio_atraso_ate": "XXX", "codigo_faixa": "XXX" }, { "ano_compromisso": "XX", "mes_compromisso": "XX", "codigo_faixa_a_vencer": "XXX" }, { "ano_compromisso": "XX", "mes_compromisso": "XX", "codigo_faixa_a_vencer": "XXX" }, { "descricao": "AMOSTRA", "valor_potencial": "HOMOLOGACAO", "media_potencial": "AMOSTRA", "codigo_valor": "XXX", "codigo_media": "XXX" }, { "descricao": "DEMONSTRACAO", "valor_potencial": "AMOSTRA", "media_potencial": "DEMONSTRACAO", "codigo_valor": "XXX", "codigo_media": "XXX" }, { "descricao": "EXEMPLO", "valor_potencial": "AMOSTRA", "media_potencial": "HOMOLOGACAO", "codigo_valor": "XXX", "codigo_media": "XXX" }, { "descricao": "HOMOLOGACAO", "valor_potencial": "DEMONSTRACAO", "media_potencial": "AMOSTRA", "codigo_valor": "XXX", "codigo_media": "XXX" }, { "descricao_negocio": "AMOSTRA", "descricao_faixa_valor_potencial": "HOMOLOGACAO", "descricao_faixa_media_potencial": "AMOSTRA", "codigo_faixa_valor_potencial": "XXX", "codigo_faixa_media_potencial": "XXX" }, { "descricao_negocio": "DEMONSTRACAO", "descricao_faixa_valor_potencial": "AMOSTRA", "descricao_faixa_media_potencial": "DEMONSTRACAO", "codigo_faixa_valor_potencial": "XXX", "codigo_faixa_media_potencial": "XXX" }, { "valor_potencial_de": 23750, "valor_potencial_ate": 480000, "valor_faixa_media_potencial_de": 480000, "valor_faixa_media_potencial_ate": 9900, "descricao_negocio": "EXEMPLO", "descricao_faixa_valor_potencial": "AMOSTRA", "descricao_faixa_media_potencial": "HOMOLOGACAO", "codigo_faixa_valor_potencial": "XXX", "codigo_faixa_media_potencial": "XXX", "segmento_origem_informacao": "XXX" }, { "valor_potencial_de": 480000, "valor_potencial_ate": 9900, "valor_faixa_media_potencial_de": 9900, "valor_faixa_media_potencial_ate": 1500, "descricao_negocio": "HOMOLOGACAO", "descricao_faixa_valor_potencial": "DEMONSTRACAO", "descricao_faixa_media_potencial": "AMOSTRA", "codigo_faixa_valor_potencial": "XXX", "codigo_faixa_media_potencial": "XXX", "segmento_origem_informacao": "XXX" }, { "quantidade_fontes_informacoes": 128, "quantidade_fontes_evolucao": 128, "quantidade_fontes_referenciais": 675, "quantidade_fontes_pagamento_a_vista": 128, "quantidade_fontes_historico": 12 }, { "quantidade_fontes_informacoes": 675, "quantidade_fontes_evolucao": 675, "quantidade_fontes_referenciais": 3, "quantidade_fontes_pagamento_a_vista": 675, "quantidade_fontes_historico": 47 }, { "quantidade_fontes_relacionamento": 675, "descricao_periodo_relacionamento": "AMOSTRA" }, { "quantidade_fontes_relacionamento": 3, "descricao_periodo_relacionamento": "DEMONSTRACAO" } ] }, "identificacao": { "situacao_cadastral": "REGULAR", "data_fundacao": "2024-09-02", "fax": 128, "qtde_empregados": 675, "percentual_compra": 875, "percentual_vendas": 123, "qtde_filiais": 128, "numero_inscricao_no_registro_empresas": 675, "tp_inf_2_identificacao": "04", "mensagem_status_empresa": "DEMONSTRACAO", "cidade": "SAO PAULO", "ramo": "HOMOLOGACAO", "uf": "SP", "cep": "01310930", "ddd": "11", "telefone": "30303030", "bairro": "CENTRO", "nome_fantasia_empresa": "AMOSTRA", "cnae": "4712100", "endereco": "HOMOLOGACAO", "descricao_tipo_sociedade": "DEMONSTRACAO", "area_reservada": "HOMOLOGACAO", "codigo_atividade_serasa": "HOMOLOG" }, "indice_mercado": { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "limite_credito": { "total": 2, "data": "2022-01-18", "valor": 480000, "hora": "HOMOLO", "itens": [ { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "orgaos_publicos": { "total": 6, "itens": [ { "modalidade": "OUT", "data_atualizacao": "2023-04-15", "data_vencimento": "2025-07-30", "valor_anotacao": 23750, "avalista": true, "hora_atualizacao": "HOMOLOGA", "origem_anotacao": "AMOSTRA", "sigla_estado": "XX", "contrato_anotacao": "HOMOLOGACAO" }, { "modalidade": "OUT", "data_atualizacao": "2022-01-18", "data_vencimento": "2024-09-02", "valor_anotacao": 480000, "avalista": false, "hora_atualizacao": "AMOSTRA", "origem_anotacao": "DEMONSTRACAO", "sigla_estado": "XX", "contrato_anotacao": "AMOSTRA" }, { "data_atualizacao": "2023-04-15", "total": 128, "total_das_anotacoes": 23750, "hora_atualizacao": "HOMOLOGA" }, { "data_atualizacao": "2022-01-18", "total": 675, "total_das_anotacoes": 480000, "hora_atualizacao": "AMOSTRA" }, { "data_atualizacao": "2023-04-15", "hora_atualizacao": "HOMOLOGA", "mensagem_retorno": "EXEMPLO" }, { "data_atualizacao": "2022-01-18", "hora_atualizacao": "AMOSTRA", "mensagem_retorno": "HOMOLOGACAO" } ] }, "pendencias_financeiras": { "credor": "COMERCIO EXEMPLO LTD", "contrato": "03554", "ultima_ocorrencia": "2025-07-30", "data": "2024-09", "total": 128, "valor": 480000, "valor_total": 23750, "avalista": true, "mensagem": "CONSULTA REALIZADA COM SUCESSO", "tipo": "HOMOLOGACAO", "filial_ocorrencia": "EXEM" }, "pontualidade_pagamentos": { "pontualiade_pagamentos": 128, "codigo": "XXX", "texto": "HOMOLOGACAO" }, "relacionamento_mais_antigo": { "mes": "XXX", "ano": "DEMO" }, "resumo_concentre": { "credor": "COMERCIO EXEMPLO LTD", "quantidade": 12, "ano_inicial": 67, "valor": 480000, "valor_total": 23750, "mensagem": "CONSULTA REALIZADA COM SUCESSO", "ocorrencia": "EXEMPLO", "mes_inicial": "XXX", "mes_inicial_ocorrencia": "XX", "mes_final": "XXX", "mes_final_ocorrencia": "XX", "ano_final": "XX", "moeda": "XXX", "agencia_ocorrencia": "HOMO" }, "risco_setor": { "data_consulta": "2024-09-02", "valor_prinad": 8.75, "hora_consulta": "HOMOLOGA", "fator_scoring_pj": "DEMO" }, "score": { "probabilidade_inadimplencia": 8.75, "fator_riskscoring": "DEMO" }, "socios": { "total": 2, "itens": [ { "data_atualizacao": "2023-04-15", "data_emissao_rg": "2024-09-02", "documento_socio": "HOMOLOGAC", "nome_socio": "HOMOLOGACAO", "numero_rg_socio": "HOMOLOGACAO", "vinculo_socio_com_a_empresa": "D", "estado": "SP", "ddd_telefone": "AMOS", "numero_telefone": "HOMOLOGAC", "ramal": "DEMO", "nome_logradouro": "EXEMPLO", "bairro": "CENTRO", "cidade": "SAO PAULO", "estado_endereco": "XX", "numero_celular": "DEMONSTRA", "tempo_residencia": "HOMO" }, { "data_atualizacao": "2022-01-18", "data_emissao_rg": "2023-04-15", "documento_socio": "AMOSTRA", "nome_socio": "AMOSTRA", "numero_rg_socio": "AMOSTRA", "vinculo_socio_com_a_empresa": "A", "estado": "SP", "ddd_telefone": "DEMO", "numero_telefone": "AMOSTRA", "ramal": "EXEM", "nome_logradouro": "HOMOLOGACAO", "bairro": "CENTRO", "cidade": "SAO PAULO", "estado_endereco": "XX", "numero_celular": "EXEMPLO", "tempo_residencia": "AMOS" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/credit-bureau": { "get": { "summary": "Consulta credit bureau", "operationId": "consultar_credit_bureau", "tags": [ "fisica" ], "parameters": [ { "name": "cpf", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "alerta_obito", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "alerta_identidade", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_credit_bureau" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "credit_bureau", "produto_id": 4042, "documento": "11144477735", "tipo_pessoa": "fisica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "alertas": { "total": 10, "itens": [ { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "data_ocorrencia": "2025-07-30", "data": "2025-07-30", "total_cheques_devolvidos": 128, "valor_cheque_devolvido": 480000, "total": 675, "registro_b360_detalhe_cheque_sem_fundos_bp24": "B360", "numero_cheque": "HOMOLO", "alinea_devolucao_cheque": "XX", "tipo_moeda": "XXX", "banco": "BAN", "uso_reservado_serasa": "EXEMPLO", "agencia": "0001", "cidade": "SAO PAULO", "estado": "SP", "tipo_conta": "9", "numero_conta_corrente": "EXEMPLO", "filler": "XXX" }, { "data_ocorrencia": "2024-09-02", "data": "2024-09-02", "total_cheques_devolvidos": 675, "valor_cheque_devolvido": 9900, "total": 3, "registro_b360_detalhe_cheque_sem_fundos_bp24": "B360", "numero_cheque": "AMOSTR", "alinea_devolucao_cheque": "XX", "tipo_moeda": "XXX", "banco": "BAN", "uso_reservado_serasa": "HOMOLOGACAO", "agencia": "0001", "cidade": "SAO PAULO", "estado": "SP", "tipo_conta": "I", "numero_conta_corrente": "HOMOLOGAC", "filler": "XXX" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem_retorno_nao_calculo": "EXEMPLO" }, { "mensagem_retorno_nao_calculo": "HOMOLOGACAO" } ] }, "consultas_anteriores": { "total": 2, "data_ultima_atualizacao": "2024-09", "total_consultas_credito": 3, "total_consultas_a_cheques": 12, "itens": [ { "empresa": "AMOSTRA", "data": "2024-09-02" }, { "empresa": "DEMONSTRACAO", "data": "2023-04-15" } ] }, "identificacao": { "nome": "CARLOS EXEMPLO ROCHA", "nome_mae": "TEREZA EXEMPLO ROCHA", "cpf": "47004532577", "data_ultima_alteracao_cadastral": "2024-09-02", "data_nascimento_informada_pela_empresa": "2022-01-18", "cidade_nascimento": "2023-04-15", "data_nascimento": "2023-04-15", "atualizado_em": "2024-09-02", "data_emissao": "2023-04-15", "numero_dependentes": 3, "estado_civil": "DEMONSTRACAO", "escolaridade": "AMOSTRA", "sigla_estado_nascimento": "20", "cpf_conjuge": "52998224725", "ddd_telefone_residencial": "XXX", "sexo": "F", "nome_tipo_documento_identificacao": "HOMOLOGACAO", "telefone_residencial": "DEMONSTRA", "ddd": "XXXA", "ddd_telefone_comercial": "XXX", "cidade": "SAO", "telefone_comercial": "AMOSTRA", "rg": "AMOSTRA", "telefone": "MOSTRA", "ramal_telefone_comercial": "AMOS", "telefone_celular": "HOMOLOGA", "numero_telefone_celular": "HOMOLOGAC", "orgao": "AMOST", "situacao_cpf_receita_federal": "6", "ddd_celular": "XXX" }, "mensagens": { "total": 4, "itens": [ { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mais_antiga": "2023-12", "mais_recente": "2023-12", "total": 675, "valor_ultima_ocorrencia": 9900, "registro_b359_resumo_cheque_sem_fundo_bx20": "B359", "descricao_tipo_ocorrencia": "EXEMPLO", "tipo_moeda_tabela_10": "XXX", "banco": "BANCO EXEMPLO SA", "agencia_banco": "DEMO", "filler": "EXEMPLO" }, { "mais_antiga": "2025-06", "mais_recente": "2025-06", "total": 3, "valor_ultima_ocorrencia": 1500, "registro_b359_resumo_cheque_sem_fundo_bx20": "B359", "descricao_tipo_ocorrencia": "HOMOLOGACAO", "tipo_moeda_tabela_10": "XXX", "banco": "BANCO EXEMPLO SA", "agencia_banco": "EXEM", "filler": "HOMOLOGACAO" } ] }, "score": { "pontuacao": 675, "probabilidade_inadimplencia": 2.2, "descricao_scoring_escolhido": "EXEM", "nome_das_faixas": "DEMONS" } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/concentre/pf": { "get": { "summary": "Consulta concentre pf", "operationId": "consultar_concentre_pf", "tags": [ "fisica" ], "parameters": [ { "name": "cpf", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "ddd", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "registro_consultas", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "concentre_detalhe", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "indi_merca", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_concentre_pf" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "concentre_pf", "produto_id": 4012, "documento": "11144477735", "tipo_pessoa": "fisica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "consultas_anteriores": { "competencia": "2024-09", "mes_1": "2025-06", "mes_2": "2024-09", "mes_3": "2025-06", "mes_4": "2024-09", "quantidade_1": 128, "quantidade_2": 128, "quantidade_3": 675, "quantidade_4": 3, "quantidade": 128 }, "identificacao": { "nome": "CARLOS EXEMPLO ROCHA", "nome_mae": "TEREZA EXEMPLO ROCHA", "situacao_cadastral": "2", "data_nascimento": "2023-04-15", "atualizado_em": "2023-04-15" }, "participacoes": { "total": 4, "itens": [ { "empresa": "AMOSTRA", "cnpj": "11222333000181", "desde": "2022-01-18", "atualizado_em": "2023-04-15", "participacao": 87.5, "uf": "SP" }, { "empresa": "DEMONSTRACAO", "cnpj": "05795928000123", "desde": "2025-07-30", "atualizado_em": "2022-01-18", "participacao": 450, "uf": "SP" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "score": { "data_referencia": "2022-01-18", "pontuacao": 12, "probabilidade_inadimplencia": 2.2, "mensagem": "CONSULTA REALIZADA COM SUCESSO" } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/concentre/pj": { "get": { "summary": "Consulta concentre pj", "operationId": "consultar_concentre_pj", "tags": [ "juridica" ], "parameters": [ { "name": "cnpj", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "ddd", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "concentre_detalhe", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "part_empre", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "indi_merca", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "faturamento_presumido", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "limite_credito", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "registro_consultas", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_concentre_pj" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "concentre_pj", "produto_id": 4013, "documento": "11222333000181", "tipo_pessoa": "juridica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "administradores": { "total": 2, "itens": [ { "documento": "51509732640125", "nome": "MARIA SOUZA COMERCIO LTDA", "cargo": "AMOSTRA", "tem_restricao": true }, { "documento": "11222333000181", "nome": "MARIA SOUZA COMERCIO LTDA", "cargo": "DEMONSTRACAO", "tem_restricao": false } ] }, "consultas_anteriores": { "competencia": "2024-09", "quantidade": 128 }, "identificacao": { "razao_social": "MARIA SOUZA COMERCIO LTDA", "nome_fantasia": "EXEMPLO COMERCIO", "situacao_cadastral": "2", "data_fundacao": "2022-01-18", "atualizado_em": "2023-04-15", "uf": "SP", "municipio": "SAO PAULO" }, "limite_credito": { "total": 8, "valor": 480000, "mensagem": "CONSULTA REALIZADA COM SUCESSO", "itens": [ { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "score": { "data_consulta": "2022-01-18", "pontuacao": 47, "probabilidade_inadimplencia": 12.34, "hora_consulta": "DEMONSTR", "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "socios": { "total": 2, "itens": [ { "documento": "51509732640125", "nome": "MARIA SOUZA COMERCIO LTDA", "percentual_capital": 450 }, { "documento": "11222333000181", "nome": "MARIA SOUZA COMERCIO LTDA", "percentual_capital": 22 } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/crednet/pf": { "get": { "summary": "Consulta crednet pf", "operationId": "consultar_crednet_pf", "tags": [ "fisica" ], "parameters": [ { "name": "cpf", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ddd", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cep", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "alerta_obito", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "relacionamento_mercado", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "renda_pro", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "score", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "hist_pagamento", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "indic_rec_cred", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_crednet_pf" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "crednet_pf", "produto_id": 3973, "documento": "11144477735", "tipo_pessoa": "fisica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "acoes_judiciais": { "total": 4, "itens": [ { "natureza": "XXX", "data": "2024-09-02", "vara": 3, "distr": 47, "valor": 1500, "uf": "SP", "cidade": "SAO PAULO" }, { "natureza": "XXX", "data": "2023-04-15", "vara": 12, "distr": 128, "valor": 23750, "uf": "SP", "cidade": "SAO PAULO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "alertas": { "total": 16, "itens": [ { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "sequencia": 12, "documento": "00000005795928000123", "data_ocorrencia": "2024-09-02", "total": 47, "motivo_ocorrencia": "AMOS" }, { "sequencia": 47, "documento": "00000051509732640125", "data_ocorrencia": "2023-04-15", "total": 12, "motivo_ocorrencia": "DEMO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "cheques": { "total": 4, "itens": [ { "data_ocorrencia": "2024-09-02", "quantidade_ccf_para_o_banco": 675, "valor_total_cheque": 9900, "numero_cheque": "AMOSTRA", "alinea_cheque": "DEMON", "nome_banco": "EXEMPLO", "numero_agencia": "DEMO", "cidade_agencia": "DEMONSTRACAO", "uf_agencia": "XX" }, { "data_ocorrencia": "2023-04-15", "quantidade_ccf_para_o_banco": 3, "valor_total_cheque": 1500, "numero_cheque": "DEMONSTRAC", "alinea_cheque": "EXEMP", "nome_banco": "HOMOLOGACAO", "numero_agencia": "EXEM", "cidade_agencia": "EXEMPLO", "uf_agencia": "XX" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "comprometimento_renda": { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "consultas_anteriores": { "ultimos_15_dias": 12, "de_16_a_30_dias": 3, "de_31_a_60_dias": 128, "de_61_a_90_dias": 675, "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "falencias": { "total": 4, "itens": [ { "data_ocorrencia": "2024-09-02", "data_inclusao_anotacao": "2023-04-15", "numero_vara_civel": "DEMO", "sigla_unidade_federacao": "XX", "nome_cidade": "DEMONSTRACAO", "numero_filial_cnpj_consultado": "HOMO", "hora_inclusao_anotacao": "DEMONS", "descricao_natureza": "EXEMPLO", "codigo_natureza": "XX", "codigo_praca_embratel": "AMOS" }, { "data_ocorrencia": "2023-04-15", "data_inclusao_anotacao": "2022-01-18", "numero_vara_civel": "EXEM", "sigla_unidade_federacao": "XX", "nome_cidade": "EXEMPLO", "numero_filial_cnpj_consultado": "AMOS", "hora_inclusao_anotacao": "EXEMPL", "descricao_natureza": "HOMOLOGACAO", "codigo_natureza": "XX", "codigo_praca_embratel": "DEMO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "historico_pagamentos": { "total": 6, "itens": [ { "periodo_dias": "HOMOLOG" }, { "periodo_dias": "AMOSTRA" }, { "periodo_dias": "HOMOLOG" }, { "periodo_dias": "AMOSTRA" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "identificacao": { "nome": "CARLOS EXEMPLO ROCHA", "nome_mae": "TEREZA EXEMPLO ROCHA", "situacao_cadastral": "SUSPENSA", "data_nascimento": "2022-01-18", "atualizado_em": "2023-04-15", "situacao_cadastral_origem": "6" }, "indice_mercado": { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "participacoes": { "total": 4, "itens": [ { "empresa": "AMOSTRA", "cnpj": "05795928000123", "desde": "2024-09-02", "atualizado_em": "2023-04-15", "participacao": 12.34, "tem_restricao": true, "uf": "SP" }, { "empresa": "DEMONSTRACAO", "cnpj": "51509732640125", "desde": "2023-04-15", "atualizado_em": "2022-01-18", "participacao": 8.75, "tem_restricao": false, "uf": "SP" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "participacoes_insucesso": { "total": 4, "itens": [ { "data_ocorrencia": "2024-09-02", "data_inclusao_anotacao": "2023-04-15", "numero_vara_civel": "DEMO", "nome_empresa_em_que_participa": "DEMONSTRACAO", "numero_filial_cnpj_consultado": "HOMO", "hora_inclusao_anotacao": "DEMONS", "codigo_natureza": "XX", "codigo_qualificacao": "XXX" }, { "data_ocorrencia": "2023-04-15", "data_inclusao_anotacao": "2022-01-18", "numero_vara_civel": "EXEM", "nome_empresa_em_que_participa": "EXEMPLO", "numero_filial_cnpj_consultado": "AMOS", "hora_inclusao_anotacao": "EXEMPL", "codigo_natureza": "XX", "codigo_qualificacao": "XXX" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "pendencias_financeiras": { "total": 47, "tipo_anotacao": "I", "mais_antiga": "2023-12", "mais_recente": "2025-06", "valor_total": 1500, "itens": [ { "empresa": "AMOSTRA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data_ocorrencia": "2024-09-02", "valor": 1500, "avalista": true, "praca": "SAO" }, { "empresa": "DEMONSTRACAO", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data_ocorrencia": "2023-04-15", "valor": 23750, "avalista": true, "praca": "SAO" }, { "tipo_anotacao": "5" }, { "tipo_anotacao": "V" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "pendencias_internas": { "total": 4, "itens": [ { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2024-09-02", "valor": 1500, "uf": "SP" }, { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2023-04-15", "valor": 23750, "uf": "SP" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "protestos": { "total": 4, "itens": [ { "data": "2024-09-02", "valor": 1500, "cartorio": "2", "cidade": "SAO PAULO", "uf": "SP" }, { "data": "2023-04-15", "valor": 23750, "cartorio": "2", "cidade": "SAO PAULO", "uf": "SP" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "recuperacao_credito": { "classe_collection": "1", "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "renda_estimada": { "valor": 1500, "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "score": { "pontuacao": 12, "probabilidade_inadimplencia": 12.34, "mensagem": "CONSULTA REALIZADA COM SUCESSO", "taxa_estimada_inadimplencia": "EXEMP", "classe_intervalar": "DEMONS" } }, "avisos": [ { "codigo": "campo_sem_revisao", "mensagem": "2 campo(s) deste produto aguardam confirmacao de tipo e ficaram fora desta resposta.", "detalhes": { "campos": [ "historico_pagamentos.percentual_concentracao", "historico_pagamentos.percentual_concentracao" ] } } ] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/crednet/pj": { "get": { "summary": "Consulta crednet pj", "operationId": "consultar_crednet_pj", "tags": [ "juridica" ], "parameters": [ { "name": "cnpj", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ddd", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cep", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "relacionamento_mercado", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "participacao_empresa", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "faturamento_presumido", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "limite_credito", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "gasto_estimado", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "score", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "pontualidade_pagamentos", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "hist_pag_comercial", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "hist_pag_financeiro", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_crednet_pj" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "crednet_pj", "produto_id": 4008, "documento": "11222333000181", "tipo_pessoa": "juridica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "administradores": { "total": 2, "itens": [ { "cpf": "11222333000181", "nome": "MARIA SOUZA COMERCIO LTDA", "tipo_pessoa": "Jurídica", "cargo": "EXEMPLO", "consistido": "consistente", "tem_restricao": true, "tipo_pessoa_origem": "J", "consistido_origem": "C" }, { "cpf": "05795928000123", "nome": "MARIA SOUZA COMERCIO LTDA", "tipo_pessoa": "Física", "cargo": "HOMOLOGACAO", "consistido": "inconsistente", "tem_restricao": false, "tipo_pessoa_origem": "F", "consistido_origem": "I" } ] }, "alertas": { "total": 4, "itens": [ { "sequencia": 67, "documento": "00000005795928000123", "data_ocorrencia": "2023-04-15", "total": 47, "motivo_ocorrencia": "DEMO" }, { "sequencia": 3, "documento": "00000051509732640125", "data_ocorrencia": "2022-01-18", "total": 12, "motivo_ocorrencia": "EXEM" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "cheques": { "total": 47, "mais_antiga": "2025-07-30", "mais_recente": "2022-01-18", "numero_banco": "XXX", "agencia": "0001", "instituicao": "DEMONSTRACAO", "itens": [ { "ocorrencia_mais_recente": "2025-07-30", "total": 47, "valor_total": 9900, "numero_banco": "XXX", "agencia": "0001", "instituicao": "DEMONSTRACAO", "numero_cheque": "AMOSTRA", "alinea_cheque": "DEMON", "cidade": "SAO PAULO", "uf": "SP" }, { "ocorrencia_mais_recente": "2024-09-02", "total": 128, "valor_total": 1500, "numero_banco": "XXX", "agencia": "0001", "instituicao": "EXEMPLO", "numero_cheque": "DEMONSTRAC", "alinea_cheque": "EXEMP", "cidade": "SAO PAULO", "uf": "SP" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "consultas_anteriores": { "ultimos_15_dias": 675, "de_16_a_30_dias": 12, "de_31_a_60_dias": 3, "de_61_a_90_dias": 12, "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "faturamento_presumido": { "total": 2, "valor_anual": 9900, "itens": [ { "interpretacao": "DEMONSTRACAO" }, { "interpretacao": "EXEMPLO" } ] }, "historico_pagamentos_comercial": { "total": 6, "itens": [ { "valor_inicial_faixa_valor": 480000, "valor_final_faixa_valor": 480000, "percentual_a_vista": 220, "percentual_parcelado": 220, "codigo_classificacao_faixa": "XXX" }, { "valor_inicial_faixa_valor": 9900, "valor_final_faixa_valor": 9900, "percentual_a_vista": 123, "percentual_parcelado": 123, "codigo_classificacao_faixa": "XXX" }, { "valor_inicial_faixa_valor": 480000, "valor_final_faixa_valor": 480000, "percentual_pontual": 450, "percentual_em_atraso": 875, "codigo_classificacao_faixa": "XXX" }, { "valor_inicial_faixa_valor": 9900, "valor_final_faixa_valor": 9900, "percentual_pontual": 220, "percentual_em_atraso": 450, "codigo_classificacao_faixa": "XXX" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "historico_pagamentos_financeiro": { "total": 10, "itens": [ { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "valor_total_compromissos": "AMOSTRA", "quantidade_compromissos": "EXEMPLO", "codigo_faixa_total_compromissos": "XXX", "codigo_faixa_quantidade_compromissos": "XXX" }, { "valor_total_compromissos": "DEMONSTRACAO", "quantidade_compromissos": "HOMOLOGACAO", "codigo_faixa_total_compromissos": "XXX", "codigo_faixa_quantidade_compromissos": "XXX" }, { "percentual_das_parcelas_pagas": 220, "percentual_das_parcelas_a_vencer": 450, "percentual_das_parcelas_em_aberto": 450 }, { "percentual_das_parcelas_pagas": 123, "percentual_das_parcelas_a_vencer": 220, "percentual_das_parcelas_em_aberto": 220 }, { "valor_total_pago_contratos_ativos": "DEMONSTRACAO", "percentual_pontualidade_pagamento_rotativo": "EXEMPLO", "percentual_pagamentos_parcelados_pontual": "EXEMPLO", "percentual_pagamentos_parcelados_em_atraso": "DEMONSTRACAO", "codigo_faixa_total_pago_contratos_ativos": "XXX" }, { "valor_total_pago_contratos_ativos": "EXEMPLO", "percentual_pontualidade_pagamento_rotativo": "HOMOLOGACAO", "percentual_pagamentos_parcelados_pontual": "HOMOLOGACAO", "percentual_pagamentos_parcelados_em_atraso": "EXEMPLO", "codigo_faixa_total_pago_contratos_ativos": "XXX" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "identificacao": { "razao_social": "MARIA SOUZA COMERCIO LTDA", "situacao_cadastral": "SUSPENSA", "data_fundacao": "2022-01-18", "atualizado_em": "2023-04-15", "situacao_cadastral_origem": "6" }, "indice_mercado": { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "limite_credito": { "total": 2, "valor": 1500, "itens": [ { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "participacoes": { "total": 4, "itens": [ { "cnpj": "05795928000123", "empresa": "AMOSTRA", "cidade": "SAO PAULO", "uf": "SP" }, { "cnpj": "51509732640125", "empresa": "DEMONSTRACAO", "cidade": "SAO PAULO", "uf": "SP" }, { "documento": "05795928000123", "vinculo": "HOMOLOGACAO", "percentual_capital": 22, "participante": "DEMONSTRACAO" }, { "documento": "51509732640125", "vinculo": "AMOSTRA", "percentual_capital": 123.4, "participante": "EXEMPLO" } ] }, "pendencias_financeiras": { "total": 47, "tipo_anotacao": "5", "mais_antiga": "2023-12", "mais_recente": "2025-06", "valor_total": 9900, "itens": [ { "empresa": "AMOSTRA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2025-07-30", "valor": 1500, "avalista": true, "praca": "SAO" }, { "empresa": "DEMONSTRACAO", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2024-09-02", "valor": 23750, "avalista": true, "praca": "SAO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "pendencias_internas": { "total": 47, "valor_total": 9900, "itens": [ { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2025-07-30", "valor": 1500, "uf": "SP", "reservado": "XX" }, { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2024-09-02", "valor": 23750, "uf": "SP", "reservado": "XX" } ] }, "pontualidade_pagamentos": { "pontuacao": 3, "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "protestos": { "total": 47, "mais_antiga": "2023-12", "mais_recente": "2025-06", "valor_total": 9900, "itens": [ { "data": "2025-07-30", "valor": 1500, "cartorio": "2", "cidade": "SAO PAULO", "uf": "SP" }, { "data": "2024-09-02", "valor": 23750, "cartorio": "2", "cidade": "SAO PAULO", "uf": "SP" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "score": { "pontuacao": 3 }, "socios": { "total": 4, "itens": [ { "documento": "05795928000123", "nome": "MARIA SOUZA COMERCIO LTDA", "tipo_pessoa": "Jurídica", "consistido": "consistente", "situacao_capital_total": "EMPRESA COM % > ou = 95% e < ou = 100 %", "percentual_capital": 22, "tem_restricao": true, "tipo_pessoa_origem": "J", "consistido_origem": "C", "situacao_capital_total_origem": "F" }, { "documento": "51509732640125", "nome": "MARIA SOUZA COMERCIO LTDA", "tipo_pessoa": "Física", "consistido": "inconsistente", "situacao_capital_total": "EMPRESA COM % MAIOR QUE 100%", "percentual_capital": 123.4, "tem_restricao": false, "tipo_pessoa_origem": "F", "consistido_origem": "I", "situacao_capital_total_origem": "M" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/crednet-light/pf": { "get": { "summary": "Consulta crednet light pf", "operationId": "consultar_crednet_light_pf", "tags": [ "fisica" ], "parameters": [ { "name": "cpf", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ddd", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cep", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "score", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_crednet_light_pf" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "crednet_light_pf", "produto_id": 4009, "documento": "11144477735", "tipo_pessoa": "fisica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "acoes_judiciais": { "total": 4, "itens": [ { "natureza": "XXX", "data": "2022-01-18", "vara": 47, "distr": 47, "valor": 9900, "uf": "SP", "cidade": "SAO PAULO" }, { "natureza": "XXX", "data": "2025-07-30", "vara": 128, "distr": 128, "valor": 1500, "uf": "SP", "cidade": "SAO PAULO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "alertas": { "total": 4, "itens": [ { "sequencia": 67, "documento": "00000011222333000181", "data_ocorrencia": "2023-04-15", "total_mensagem": 67, "motivo_ocorrencia": "EXEM" }, { "sequencia": 3, "documento": "00000005795928000123", "data_ocorrencia": "2022-01-18", "total_mensagem": 3, "motivo_ocorrencia": "HOMO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "cheques": { "total": 4, "itens": [ { "data": "2022-01-18", "cheque_no": 12, "alinea": 128, "qtde": 675, "valor": 9900, "banco": "BANCO EXEMPLO", "agencia": "0001", "cidade": "SAO PAULO" }, { "data": "2025-07-30", "cheque_no": 47, "alinea": 675, "qtde": 3, "valor": 1500, "banco": "BANCO EXEMPLO", "agencia": "0001", "cidade": "SAO PAULO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "consultas_anteriores": { "ultimos_15_dias": 3, "de_16_a_30_dias": 12, "de_31_a_60_dias": 128, "de_61_a_90_dias": 128, "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "falencias": { "total": 4, "itens": [ { "data_ocorrencia": "2023-04-15", "data_inclusao_anotacao": "2025-07-30", "numero_vara_civel": "HOMO", "sigla_unidade_federacao": "XX", "nome_cidade": "AMOSTRA", "numero_filial_cnpj_consultado": "AMOS", "hora_inclusao_anotacao": "HOMOLO", "descricao_natureza": "AMOSTRA", "codigo_natureza": "XX", "codigo_praca_embratel": "EXEM" }, { "data_ocorrencia": "2022-01-18", "data_inclusao_anotacao": "2024-09-02", "numero_vara_civel": "AMOS", "sigla_unidade_federacao": "XX", "nome_cidade": "DEMONSTRACAO", "numero_filial_cnpj_consultado": "DEMO", "hora_inclusao_anotacao": "AMOSTR", "descricao_natureza": "DEMONSTRACAO", "codigo_natureza": "XX", "codigo_praca_embratel": "HOMO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "identificacao": { "nome": "CARLOS EXEMPLO ROCHA", "nome_mae": "TEREZA EXEMPLO ROCHA", "situacao_cadastral": "REGULAR", "data_nascimento": "2025-07-30", "atualizado_em": "2025-07-30", "situacao_cadastral_origem": "2" }, "participacoes_insucesso": { "total": 4, "itens": [ { "data_ocorrencia": "2023-04-15", "data_inclusao_anotacao": "2025-07-30", "numero_vara_civel": "HOMO", "nome_empresa_em_que_participa": "EXEMPLO", "numero_filial_cnpj_consultado": "AMOS", "hora_inclusao_anotacao": "HOMOLO", "codigo_natureza": "XX", "codigo_qualificacao": "XXX" }, { "data_ocorrencia": "2022-01-18", "data_inclusao_anotacao": "2024-09-02", "numero_vara_civel": "AMOS", "nome_empresa_em_que_participa": "HOMOLOGACAO", "numero_filial_cnpj_consultado": "DEMO", "hora_inclusao_anotacao": "AMOSTR", "codigo_natureza": "XX", "codigo_qualificacao": "XXX" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "pendencias_financeiras": { "total": 675, "tipo_anotacao": "I", "mais_antiga": "2025-06", "mais_recente": "2024-09", "valor_total": 9900, "itens": [ { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2022-01-18", "valor": 9900, "avalista": true, "praca": "SAO" }, { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2025-07-30", "valor": 1500, "avalista": true, "praca": "SAO" }, { "tipo_anotacao": "I" }, { "tipo_anotacao": "5" } ] }, "pendencias_internas": { "total": 4, "itens": [ { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data_ocorrencia": "2023-04-15", "valor": 9900, "avalista": true, "tipo_moeda": "XXX", "sigla_embratel_praca_ocorrencia": "AMOS" }, { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data_ocorrencia": "2022-01-18", "valor": 1500, "avalista": true, "tipo_moeda": "XXX", "sigla_embratel_praca_ocorrencia": "DEMO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "protestos": { "total": 4, "itens": [ { "data": "2022-01-18", "valor": 9900, "cartorio": "2", "cidade": "SAO PAULO", "uf": "SP" }, { "data": "2025-07-30", "valor": 1500, "cartorio": "2", "cidade": "SAO PAULO", "uf": "SP" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "score": { "pontuacao": 12, "probabilidade_inadimplencia": 12.34, "mensagem": "CONSULTA REALIZADA COM SUCESSO" } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/crednet-light/pj": { "get": { "summary": "Consulta crednet light pj", "operationId": "consultar_crednet_light_pj", "tags": [ "juridica" ], "parameters": [ { "name": "cnpj", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ddd", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cep", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "score", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_crednet_light_pj" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "crednet_light_pj", "produto_id": 4010, "documento": "11222333000181", "tipo_pessoa": "juridica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "alertas": { "total": 4, "itens": [ { "sequencia": 12, "documento": "00000005795928000123", "data_ocorrencia": "2024-09-02", "total_mensagem": 47, "motivo_ocorrencia": "HOMO" }, { "sequencia": 47, "documento": "00000051509732640125", "data_ocorrencia": "2023-04-15", "total_mensagem": 12, "motivo_ocorrencia": "AMOS" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "cheques": { "total": 4, "itens": [ { "data": "2023-04-15", "no_cheque": 47, "alinea": 12, "quantidade": 12, "valor": 9900, "banco": "BANCO EXEMPLO", "agencia": "0001", "cidade": "SAO PAULO" }, { "data": "2022-01-18", "no_cheque": 128, "alinea": 47, "quantidade": 47, "valor": 1500, "banco": "BANCO EXEMPLO", "agencia": "0001", "cidade": "SAO PAULO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "consultas_anteriores": { "ultimos_15_dias": 675, "de_16_a_30_dias": 3, "de_31_a_60_dias": 3, "de_61_a_90_dias": 12, "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, "identificacao": { "nome_mae": "TEREZA EXEMPLO ROCHA", "razao_social": "MARIA SOUZA COMERCIO LTDA", "situacao_cadastral": "BAIXADA", "data_fundacao": "2024-09-02", "atualizado_em": "2025-07-30", "situacao_cadastral_origem": "7" }, "limite_credito": { "total": 2, "valor": 9900, "itens": [ { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "pendencias_financeiras": { "total": 47, "tipo_anotacao": "5", "mais_antiga": "2025-06", "mais_recente": "2023-12", "valor_total": 1500, "itens": [ { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2023-04-15", "valor": 9900, "avalista": true, "praca": "SAO" }, { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data": "2022-01-18", "valor": 1500, "avalista": true, "praca": "SAO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "pendencias_internas": { "total": 4, "itens": [ { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data_ocorrencia": "2024-09-02", "valor": 9900, "avalista": true, "tipo_moeda": "XXX", "sigla_embratel_praca_ocorrencia": "HOMO" }, { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data_ocorrencia": "2023-04-15", "valor": 1500, "avalista": true, "tipo_moeda": "XXX", "sigla_embratel_praca_ocorrencia": "AMOS" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "protestos": { "total": 4, "itens": [ { "data": "2023-04-15", "valor": 9900, "cartorio": "2", "cidade": "SAO PAULO", "uf": "SP" }, { "data": "2022-01-18", "valor": 1500, "cartorio": "2", "cidade": "SAO PAULO", "uf": "SP" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" }, { "mensagem": "CONSULTA REALIZADA COM SUCESSO" } ] }, "score": { "classe_score": "DEMO", "mensagem": "CONSULTA REALIZADA COM SUCESSO" } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/credito-basico/pf": { "get": { "summary": "Consulta credito basico pf", "operationId": "consultar_credito_basico_pf", "tags": [ "fisica" ], "parameters": [ { "name": "cpf", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tipo_venda", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "valor_transacao", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "RENDA_ESTIMADA", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "HISTORICO_PAGAMENTO", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "CAPACIDADE_PAGAMENTO", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "COMPROMETIMENTO_RENDA", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "PARTICIPACAO_SOCIETARIA", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "SCORE_POSITIVO", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "SCORE_FRAUDE_PF", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "RECOMENDACAO_LIMITE_CREDITO", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "ALERTA_OBITO", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "ANOTACOES_COMPLETAS", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_credito_basico_pf" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "credito_basico_pf", "produto_id": 4879, "documento": "11144477735", "tipo_pessoa": "fisica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "identificacao": { "documento": "43859018566", "nome": "CARLOS EXEMPLO ROCHA", "nome_mae": "TEREZA EXEMPLO ROCHA", "situacao_cadastral": "REGULAR", "data_nascimento": "1979-12-09", "data_situacao_cadastral": "2026-01-15" }, "score": { "pontuacao": 675, "modelo": "SCORE PF SERASA v3", "faixa": "DE 501 A 700", "probabilidade_inadimplencia": 0, "mensagem": "RISCO BAIXO DE INADIMPLENCIA NOS PROXIMOS 12 MESES" }, "pendencias_financeiras": { "total": 0, "valor_total": 0, "itens": [] }, "restricoes_financeiras": { "total": 0, "valor_total": 0, "itens": [] }, "protestos": { "total": 0, "valor_total": 0, "itens": [] }, "cheques": { "total": 0, "valor_total": 0, "itens": [] }, "pendencias_internas": { "total": 0, "valor_total": 0, "itens": [] }, "consultas_anteriores": { "total": 3, "total_mes_corrente": 0, "por_competencia": { "total": 4, "itens": [ { "competencia": "2026-01", "quantidade": 1 }, { "competencia": "2026-01", "quantidade": 1 }, { "competencia": "2026-01", "quantidade": 1 }, { "competencia": "2026-01", "quantidade": 0 } ] }, "itens": [ { "segmento": "COMERCIO VAREJISTA", "data_ocorrencia": "2026-01-15", "quantidade": 1 }, { "segmento": "INSTITUICAO FINANCEIRA", "data_ocorrencia": "2026-01-15", "quantidade": 1 }, { "segmento": "TELECOMUNICACOES", "data_ocorrencia": "2026-01-15", "quantidade": 1 } ] }, "participacoes": { "total": 1, "valor_total": 0, "itens": [ { "documento": "21325505253223", "razao_social": "INDUSTRIA FICTICIA SA", "situacao_cadastral": "ATIVA", "situacao_cadastral_origem": "2", "uf": "SC", "data_situacao_cadastral": "2026-01-15", "atualizado_em": "2026-01-15", "percentual_capital": 100, "tem_restricao": false } ] }, "alertas": { "total": 1, "itens": [ { "tipo": "obito", "codigo": "0000", "mensagem": "NAO CONSTA REGISTRO DE OBITO PARA O DOCUMENTO CONSULTADO" } ] } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/consultas/credito-basico/pj": { "get": { "summary": "Consulta credito basico pj", "operationId": "consultar_credito_basico_pj", "tags": [ "juridica" ], "parameters": [ { "name": "cnpj", "in": "query", "required": true, "description": "com ou sem mascara", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tipo_venda", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "valor_transacao", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "RECOMENDACAO_LIMITE_CREDITO", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "GASTO_ESTIMADO_POSITIVO", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "LIMITE_CREDITO", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "ANOTACOES_COMPLETAS", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "SCORE_SOCIO_PF", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "MAIS_ANOTACOES", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "PONTUALIDADE_PAGAMENTO", "in": "query", "required": false, "description": "feature opcional; envie 1 para ligar (cobrada a parte)", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "Consulta realizada. Se o documento nao tem informacao na base, `dados` vem vazio, `avisos` traz consulta_sem_retorno e a consulta nao e cobrada.", "content": { "application/json": { "schema": { "type": "object", "required": [ "consulta", "dados", "avisos" ], "properties": { "consulta": { "$ref": "#/components/schemas/Consulta" }, "dados": { "$ref": "#/components/schemas/Dados_credito_basico_pj" }, "avisos": { "type": "array", "items": { "$ref": "#/components/schemas/Aviso" } } } }, "example": { "consulta": { "produto": "credito_basico_pj", "produto_id": 4880, "documento": "11222333000181", "tipo_pessoa": "juridica", "consultado_em": "2026-01-15T10:30:00-03:00" }, "dados": { "identificacao": { "documento": "91465466343317", "razao_social": "COMERCIO EXEMPLO LTDA", "situacao_cadastral": "REGULAR", "data_fundacao": "2005-02-14", "endereco": { "cep": "65203413", "logradouro": "AVENIDA BRASIL 1200", "bairro": "CENTRO", "cidade": "JOAO PESSOA", "uf": "PB" } }, "score": { "pontuacao": 183, "modelo": "SCORE PJ SERASA v3", "probabilidade_inadimplencia": 12.34, "mensagem": "RISCO ALTO DE INADIMPLENCIA NOS PROXIMOS 12 MESES" }, "pendencias_financeiras": { "total": 1, "valor_total": 150, "mais_antiga": "2026-01-15", "mais_recente": "2026-01-15", "itens": [ { "credor": "COMERCIO EXEMPLO LTDA", "modalidade": "OUTRAS OPERACOES", "contrato": "03554", "data_ocorrencia": "2026-01-15", "data_inclusao": "2026-01-15", "valor": 150, "principal": true, "em_disputa": false } ] }, "restricoes_financeiras": { "total": 0, "valor_total": 0, "itens": [] }, "protestos": { "total": 0, "valor_total": 0, "itens": [] }, "cheques": { "total": 0, "valor_total": 0, "itens": [] }, "pendencias_internas": { "total": 0, "valor_total": 0, "itens": [] }, "consultas_anteriores": { "total": 5, "total_mes_corrente": 2, "por_competencia": { "total": 1, "itens": [ { "competencia": "2026-01", "quantidade": 3, "quantidade_bancos": 1 } ] }, "itens": [ { "documento_consultante": "45136455020526", "consultante": "COMERCIO EXEMPLO LTDA", "data_ocorrencia": "2026-01-15", "quantidade": 1 }, { "documento_consultante": "26221449509289", "consultante": "DISTRIBUIDORA TESTE EPP", "data_ocorrencia": "2026-01-15", "quantidade": 1 }, { "documento_consultante": "10619247104357", "consultante": "INDUSTRIA FICTICIA SA", "data_ocorrencia": "2026-01-15", "quantidade": 2 }, { "documento_consultante": "33702124220020", "consultante": "SERVICOS MODELO ME", "data_ocorrencia": "2026-01-15", "quantidade": 1 }, { "documento_consultante": "21054037059495", "consultante": "COMERCIO EXEMPLO LTDA", "data_ocorrencia": "2026-01-15", "quantidade": 1 } ] }, "socios": { "total": 2, "itens": [ { "documento": "20103233199", "nome": "ANA PEREIRA LIMA", "percentual_capital": 91, "tem_restricao": false, "inconsistente": false }, { "documento": "89144605331", "nome": "BRUNO SOUZA MELO", "percentual_capital": 9, "tem_restricao": true, "inconsistente": false } ] }, "administradores": { "total": 1, "itens": [ { "documento": "20103233199", "nome": "ANA PEREIRA LIMA", "cargo": "ADMINISTRADOR", "tem_restricao": false } ] }, "alertas": { "total": 0, "itens": [] }, "pontualidade_pagamentos": { "valor": 99, "modelo": "HIP2", "mensagem": "PAGAMENTOS EM ATRASO ACIMA DA MEDIA DO SETOR", "probabilidade_inadimplencia": 8.76 }, "limite_credito": { "valor": 417167, "modelo": "HLC1", "mensagem": "LIMITE SUGERIDO COM BASE NO FATURAMENTO PRESUMIDO" } }, "avisos": [] } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } }, "/v3/features/{produto}": { "get": { "summary": "Lista as features de um produto, com liberacao e preco", "description": "Toda feature que o produto aceita na query string aparece aqui. `liberada` diz se o cliente autenticado pode usar; `preco` e o do plano ativo e vem null quando a feature nao e cobrada a parte.", "operationId": "features", "tags": [ "catalogo" ], "parameters": [ { "name": "produto", "in": "path", "required": true, "description": "mesmo slug da rota de consulta", "schema": { "type": "string", "enum": [ "relato", "credit-bureau", "concentre/pf", "concentre/pj", "crednet/pf", "crednet/pj", "crednet-light/pf", "crednet-light/pj", "credito-basico/pf", "credito-basico/pj" ] } } ], "responses": { "200": { "description": "Features do produto", "content": { "application/json": { "schema": { "type": "object", "required": [ "produto", "produto_id", "total", "itens" ], "properties": { "produto": { "type": "string" }, "produto_id": { "type": "integer" }, "total": { "type": "integer" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } } } } } } }, "400": { "description": "documento_invalido, parametro_ausente, parametro_invalido, credenciais_ausentes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "401": { "description": "nao_autenticado, credenciais_invalidas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "403": { "description": "produto_sem_acesso, usuario_bloqueado, cliente_sem_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "429": { "description": "limite_mensal_excedido, limite_sandbox_excedido", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "502": { "description": "fornecedor_indisponivel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "504": { "description": "fornecedor_sem_resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } }, "503": { "description": "configuracao_ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } } } } }