# Documentação da API de Consultas Mix - Versão 3

Estamos empolgados em apresentar a Versão 3 (v3) da API de consultas Mix! Esta atualização traz melhorias significativas de desempenho, graças à implementação de uma arquitetura baseada em microservices, permitindo consultas em paralelo.

Nota importante: A versão 2 (v2) da API ainda está funcional, mas encorajamos fortemente a migração para a v3 para aproveitar ao máximo os avanços tecnológicos e as melhorias de desempenho.

A consulta Deps estrutura seus dados em blocos de informações, por isso, é possível que algumas estruturas (objetos) do arquivo JSON retornem com o valor null, pois o produto adquirido no PortalDeps, pode não contemplar determinados blocos de consultas.

# Principais Recursos da v3:

Desempenho aprimorado: A v3 proporciona um ganho substancial de desempenho, garantindo respostas mais rápidas e eficientes para suas consultas.
Microservices e consultas em paralelo: A adoção da arquitetura de microservices permite a execução de consultas em paralelo, otimizando a eficiência do sistema e reduzindo significativamente os tempos de resposta.

Estamos comprometidos em fornecer uma experiência de usuário excepcional e a v3 representa um passo importante em direção a esse objetivo. Não hesite em explorar e adotar as melhorias mais recentes em nossa API de consultas Mix.

# O que você encontrará neste manual 📙

Documentação da API

# Quais são os dados que a consulta oferece? 💡

A consulta abrange as seguintes informações:

Ações judiciais, inclui ações cíveis, falências e recuperação judicial;
Análise de indicadores financeiros;
Cheques devolvidos;
Contas a receber interno;
Contatos preferenciais;
Dados cadastrais de pessoa física;
Dados cadastrais de pessoa jurídica;
Dados do Sintegra;
Dados do Suframa;
Documentos roubados;
E-mails adicionais;
Endereços adicionais;
Histórico de pagamento;
Indicadores de pagamentos a fornecedores;
Participações na empresa;
Protestos;
Quadro societário;
Renda presumida com gasto estimado;
Restrições de pendências: dívidas em bancos;
SCR;
Score;
Smart - Análise de crédito;
Vínculo de pessoa física com empresa (vínculo empregatício).

Retorno de acordo com o contratado

# Por onde devo começar? 👷

Primeiro passo é obter o token, pois para as demais requisições estaremos utilizando ele. A seguir serão detalhados os passos para realizar uma consulta.

Documentação da API no Swagger:

https://api-portal.deps.com.br/swagger/index.html (opens new window)

OBS: Selecionar V3

# Obtendo o token de autenticação 🔒

Para que seja possível realizar uma consulta, primeiramente será necessário obter o token de autenticação.
O token poderá ser obtido através do método POST pelo seguinte endpoint:

https://api-portal.deps.com.br/api/v3/conta/entrar

Além do token, será enviado uma lista de produtos disponíveis para o usuário. Se o usuário não possuir acesso, a lista será retornada sem nenhum item.

Uma listando contendo o tipo de usuário também será retornanda, informando qual o tipo de usuário está efetuando login.

Clique para exibir a lista de usuários disponíveis no campo 'Role'.

  - Automacao
  - AdministradorPortal
  - AdministradorParceiro
  - UsuarioGestor
  - Usuario
  - GerenteComercial
  - Comercial
  - SuporteImplantacao
  - Financeiro
  - ComercialCliente

Clique para exibir o header da requisição.

Content-Type: application/json

Clique para exibir o corpo da requisição.

{ 
    "email": "email", 
    "senha": "senha" 
}

Clique para exibir a resposta com sucesso (200 - Success) ✔️

{
  "access_token": "string",
  "expires_in": 0,
  "role": "string",
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "nome": "string",
    "email": "string",
    "telefone": "string",
    "ativo": 0,
    "limiteDiario": 0,
    "limiteMensal": 0,
    "clienteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "usuarioIds": [
      "string"
    ],
    "permissao": "string",
    "emailConfirmado": true,
    "interfaceAcesso": "string"
  },
  "produtos": [
    {
      "identificador": "string",
      "nome": "string",
      "tipoPessoa": "string"
    }
  ]
}

Clique para exibir a resposta com erro (400 - Bad Request) ❌

{
  "codigo": "string",
  "mensagem": "string"
}

Dica! 💡

Usuário/ senha e produto de produção devem ser solicitados ao nosso setor comercial.

# Configurações do header e parâmetros de entrada - Produção ⚙️

Após ter obtido o token de autenticação, é necessária a configuração do header e dos parâmetros de entrada.

Clique para exibir o header da requisição

Content-Type: application/json
Authorization: Bearer token

Importante!

Atente-se para não esquecer de colocar a palavra-chave "Bearer" antes do token de autenticação.

Parâmetros de entrada:

Parâmetro	Tipo de dado	Descrição	Obrigatório
documento	string	Refere-se ao CPF/CNPJ a ser consultado	Sim
identificadorProduto	string	Refere-se ao código identificador do produto cadastrado no Portal Deps	Não*
reutilizarDadosExistentes	boolean	Utilizado para consultas Smart. Valor padrão: false.	Não
autorizacaoScr	boolean	Utilizado para consultas SCR. Valor padrão: false. True = Indica que o cliente é responsável pela autorização e a autorização será cadastrada automaticamente no momento que a consulta foi realizada. False = O Portal faz a verificação se já existe a autorização. Ou seja, caso não exista autorização cadastrada, a consulta não é feita.	Não
version	integer	Refere-se à versão da API Mix. Informar o valor = 3.	Sim

* Campo não obrigatório apenas em caso de uso do fluxo de consultas. Caso não possua um fluxo configurado o campo continua obrigatório. Para entender melhor o que é um fluxo de consulta e como configurar clique aqui.

Caso seja informado o parâmetro reutilizarDadosExistentes com o valor true, o Portal fará uma verificação na base de dados para saber se existe alguma consulta já realizada para o mesmo documento e produto. Caso possua, então os dados serão reutilizados e a consulta será finalizada normalmente. Caso contrário, a API retornará um erro (status code 400) com a seguinte resposta:

{
  "value": null,
  "messages": [
    "O documento consultado não possui informações na base de dados"
  ],
  "successMessage": null,
  "success": false
}

# Fluxo de como utilizar

📌 Lembrando que o token deve ser enviado em todas as requisições que estão abaixo dele

# Realizando consulta - Produção 🔎

A consulta DepsMix ou DepsSmart podem ser consumidas através de dois métodos: GET ou POST.

Endpoint da consulta:

https://api-portal.deps.com.br/api/v3/consultas/depsmix

Para ambos os métodos são utilizados o endpoint acima. Entretanto, o método POST pode ser utilizado nos casos em que é necessário enviar informações referentes aos dados complementares da análise, autorização de consulta SCR ou inscrição estadual. Vale ressaltar que o corpo da requisição POST não é obrigatório.

Atenção!

Quando usuário possuir ao menos um centro de custos cadastrado, o campo "codigoCentroCustos" é obrigatório. Caso contrário, o mesmo pode ser enviado nulo.

Clique para exibir o corpo da requisição POST da consulta Mix:

{
  "documento": "string",
  "identificadorProduto": "string",
  "reutilizarDadosExistentes": true,
  "historicoConsultaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "limiteRequisitado": 0,
  "informacoesComplementares": {
    "dadosComplementaresAnalise": {
      "dataPosicao": "2024-05-08T13:19:20.355Z",
      "contasReceberResumido": {
        "mediaDiasAtraso": 0,
        "mediaDiasVencido": 0,
        "mediaDiasVencer": 0,
        "totalPago": 0,
        "totalVencido": 0,
        "totalVencer": 0
      },
      "campoComplementar": 0,
      "maiorLimiteTomado": 0,
      "contasReceberDetalhado": {
        "tipoDetalhado": "string",
        "dataInicio": "2024-05-08T13:19:20.355Z",
        "dataFim": "2024-05-08T13:19:20.355Z",
        "titulos": [
          {
            "codigoTitulo": "string",
            "numeroTitulo": "string",
            "dataEmissao": "2024-05-08T13:19:20.355Z",
            "dataVencimento": "2024-05-08T13:19:20.355Z",
            "dataPagamento": "2024-05-08T13:19:20.355Z",
            "valor": 0,
            "saldo": 0
          }
        ]
      }
    },
    "autorizacaoConsulta": {
      "documento": "string",
      "nome": "string",
      "email": "string",
      "emailUsuario": "string"
    },
    "inscricaoEstadual": "string"
  },
  "codigoCentroCustos": "string",
  "autorizacaoScr": true
}

Clique para exibir a resposta com erro quando informado um documento inválido (400 - Bad Request) ❌

{
    "value": null,
    "messages": [
        "O documento 999 não pode ser consultado neste produto!"
    ],
    "successMessage": null,
    "success": false
}

Clique para exibir a resposta com erro quando não informado um centro de custos (400 - Bad Request) ❌

{
    "value": null,
    "messages": [
        "Centro de custos não encontrado."
    ],
    "successMessage": null,
    "success": false
}

# Configuração do envio contas a receber para uso do bloco Smart ⚙️

Caso queira enviar contas receber interno para análise, deve ser enviado a opção de resumido ou detalhado, não será utilizado os dois na análise.
O Envio se faz necessário caso possua o bloco de análise e sua política análise essa informação.
A informação do contas a receber ajuda a conhecer o cliente que demanda crédito através do comportamento de pagamento do mesmo. Nos próximos tópicos descrevemos cada campo do contas a receber resumido e detalhado para fácil entendimento.

# Contas a receber resumido

Endpoint POST: https://analise.deps.com.br/api/v1/contas-receber (opens new window)

Tabela explicativa do contas a receber resumido:

Clique para exibir a tabela com o descritivo.

Campos do retorno	Descrição
{
"contasReceber": [	Estrutura contas à receber
{
"documento": "string",	Informar o documento que pertence o contas a receber
"dados": {
"dataPosicao": "2022-04-26",	Informar a data da posição da informação
"contasReceberResumido": {	Estrutura para envio do contas receber resumido
"mediaDiasAtraso": 0,	Enviar a média de dias atraso
"mediaDiasVencido": 0,	Enviar a média de dias vencido
"mediaDiasVencer": 0,	Enviar a média de dias a vencer
"totalPago": 0,	Enviar valor total pago do documento
"totalVencido": 0,	Enviar valor total de vencido do documento
"totalVencer": 0	Enviar valor total a vencer do documento
},
"campoComplementar": 0,	Campo genérico
"maiorLimiteTomado": 0,	Enviar o maior limite tomado, contas a receber em aberto + pedidos em aberto em situação que tomam crédito
}
}
],
"clienteId": "string"	Não é necessário enviar este campo se enviado com usuário cliente

Importante!

Não enviar médias negativas, pagamentos pontuais e antecipados as médias devem ser enviadas valor 0.

# Contas a receber detalhado

Para o contas a receber detalhado você poderá utilizar a estrutura para integração vários documentos ou por apenas um documento.

Para o contas a receber detalhado é possivel integrar mais de um tipo, estes são: Emissão, Vencimento, Abertos, Pagos, Completo.

Endpoint POST: https://contas-receber.deps.com.br/api/v1/contas-receber/detalhado (opens new window)

Veja abaixo as tabelas explicativas do contas a receber detalhado:

Clique para exibir a tabela com o descritivo do contas a receber detalhado para vários documentos na mesma requisição.

Campos do retorno	Descrição
{
"inicio": "2023-08-14T13:50:52.002Z",	Informar a data de início
"fim": "2023-08-14T13:50:52.002Z",	Informar a data final
"clienteId": "string",	Não é necessário enviar este campo se enviado com usuário cliente
"tipoFiltro": "string",	Informar se é EMISSAO ou VENCIMENTO
"detalhado": [	Estrutura para envio do contas receber detalhado para vários documentos na mesma requisição
{
"documento": "string",	Informar o documento que pertence o contas a receber
"codigoTitulo": "string",	Informar a chave primária/código título na base do cliente, deverá ser um código único
"numeroTitulo": "string",	Número do título do contas a receber
"dataEmissao": "2023-08-14T13:50:52.002Z",	Informar a data de emissão do título
"dataVencimento": "2023-08-14T13:50:52.002Z",	Informar a data de vencimento do título
"dataPagamento": "2023-08-14T13:50:52.002Z",	Informar a data de pagamento do título (se houver)
"valor": 0,	Informar o valor do título
"saldo": 0	Informar o saldo caso o título não esteja pago por completo
}
]
}

Endpoint POST: https://contas-receber.deps.com.br/api/v1/contas-receber/detalhado/documento (opens new window)

Clique para exibir a tabela com o descritivo do contas a receber detalhado para apenas um documento na requisição.

Campos do retorno	Descrição
{
"inicio": "2023-08-14T13:50:52.002Z",	Informar a data de início
"fim": "2023-08-14T13:50:52.002Z",	Informar a data final
"clienteId": "string",	Não é necessário enviar este campo se enviado com usuário cliente
"tipoFiltro": "string",	Informar se é EMISSAO ou VENCIMENTO
"documento": "string",	Informar o documento que pertence o contas a receber
"detalhado": [	Estrutura para envio do contas receber detalhado para vários documentos na mesma requisição
{
"codigoTitulo": "string",	Informar a chave primária/código título na base do cliente, deverá ser um código único
"numeroTitulo": "string",	Número do título do contas a receber
"dataEmissao": "2023-08-14T13:50:52.002Z",	Informar a data de emissão do título
"dataVencimento": "2023-08-14T13:50:52.002Z",	Informar a data de vencimento do título
"dataPagamento": "2023-08-14T13:50:52.002Z",	Informar a data de pagamento do título (se houver)
"valor": 0,	Informar o valor do título
"saldo": 0	Informar o saldo caso o título não esteja pago por completo
}
]
}

Importante!

O contas a receber detalhado com valores negativos ou zerados não serão integrados.

# Para os modos de integração de contas a receber Pagos, Abertos e Completos há algumas regras importantes a serem seguidas:

Para o modelo Completo, ao fazer o upload de um arquivo todos os registros que ja estão no contas a receber serão substituidos pelos registros enviados no arquivo Completo;
Para o modelo Aberto, ao fazer o upload de um arquivo todos os registros de arquivos em aberto que já estão no contas a receber serão substituidos pelos registros enviados no arquivo Aberto;
Para o modelo Pago, ao fazer o upload todos os registros que ja estão no contas a receber serão substituidos pelos registros do mesmo periodo enviado no arquivo.
O modelo completo e constituido por todo tipo de registro, seja pago, aberto ou vencido;
O modelo aberto é somente para registros que estão em aberto;
O modelo pago é somente para registros que já estão pagos.

# Estrutura do arquivo JSON do contas a receber 📄

Exemplo de arquivo JSON com informações do contas a receber resumido:

Clique aqui para exibir

{
	"contasReceber": [
		{
			"documento": "00360305000104",
			"dados": {
				"dataPosicao": "2022-11-09T13:22:00.894Z",
				"contasReceberResumido": {
					"mediaDiasAtraso": 2,
					"mediaDiasVencido": 0,
					"mediaDiasVencer": 10,
					"totalPago": 250000,
					"totalVencido": 300000,
					"totalVencer": 1000000
				},
				"campoComplementar": 0,
				"maiorLimiteTomado": 60000,
				"contasReceberDetalhado": null
			}
		}
	]
}

Exemplo de arquivo JSON com informações do contas a receber detalhado por documento:

Clique aqui para exibir

{
  "inicio": "2023-01-01T14:25:23.243Z",
  "fim": "2023-08-01T14:25:23.243Z",
  "clienteId": "string",
  "tipoFiltro": "EMISSAO",
  "documento": "00360305000104",
  "detalhado": [
    {
      "codigoTitulo": "TT01",
      "numeroTitulo": "AGT09",
      "dataEmissao": "2023-01-01T14:25:23.243Z",
      "dataVencimento": "2023-01-05T14:25:23.243Z",
      "dataPagamento": "2023-01-05T14:25:23.243Z",
      "valor": 10000,
      "saldo": 0
    }
  ]
}

# Como o contas a receber é exibido na Smart

Abaixo separamos 2 exemplos de como o contas a receber é exibido na Smart.

Exemplo de como é exibido o contas a receber resumido na consulta Smart:

Exemplo de como é exibido o contas a receber detalhado na consulta Smart:

Dica 💡

Tambem é possível enviar o contas a receber via arquivo CSV para mais detalhes clique aqui

# Configuração autorização SCR ⚙️

Após ter obtido o token de autenticação, é necessário efetuar a configuração do header e dos parâmetros de entrada.
Enviar a e-mail para autorização SCR, quando o produto possuir este bloco.

Clique para exibir os detalhes a tabela com o descritivo.

Campos do retorno	Descrição
"autorizacaoConsulta": {
"documento": "string",	Documento que necessita de autorização
"nome": "string",	Nome ou razão social do documento
"email": "string"	Email que vai receber a solicitação de aprovação
},

# Configuração do envio da consulta sintegra por inscrição ⚙️

Após ter obtido o token de autenticação, é necessário a configuração do header e dos parâmetros de entrada. Enviar no campo InscriçãoEstadual a inscricao a ser consultada, caso não seja enviada ele faz a consulta pelo CNPJ.

Clique para exibir os detalhes a tabela com o descritivo.

Campo	Descrição
"inscricaoEstadual": "string"	Enviar a inscrição estadual a ser consultada

Resposta com sucesso (200 - Success) ✔️

Clique para visualizar o resultado consulta com sucesso.

{
  "consultante": "string",
  "produto": "string",
  "usuario": "string",
  "versao": "string",
  "isParcial": true,
  "isGrupo": true,
  "dataConsulta": "2023-12-02T10:28:06.371Z",
  "blocosComErros": [
    "string"
  ],
  "empresa": {
    "success": true,
    "message": "string",
    "cnpj": "string",
    "tipoUnidade": "string",
    "razaoSocial": "string",
    "nomeFantasia": "string",
    "situacaoCadastral": "string",
    "dataSituacaoCadastral": "string",
    "dataInicioAtividade": "string",
    "dataInicioAtividadeMatriz": "string",
    "motivoSituacaoCadastral": "string",
    "naturezaJuridica": "string",
    "cnaePrincipal": "string",
    "cnaesSecundarios": [
      "string"
    ],
    "endereco": "string",
    "numero": "string",
    "bairro": "string",
    "complemento": "string",
    "cep": "string",
    "uf": "string",
    "municipio": "string",
    "municipioCodigoIbge": "string",
    "qualificacaoResponsavel": "string",
    "capitalSocialEmpresa": "string",
    "faturamentoPresumido": "string",
    "porte": "string",
    "quantidadeFuncionarios": "string",
    "opcaoPeloSimples": "string",
    "dataOpcaoPeloSimples": "string",
    "dataExclusaoOpcaoPeloSimples": "string",
    "opcaoMei": "string",
    "situacaoEspecial": "string",
    "dataSituacaoEspecial": "string",
    "nomeEnteFederativo": "string",
    "quantidadeFiliais": "string",
    "possuiRestricao": "string",
    "nire": "string",
    "otimizaSemInformacao": true,
    "erro": "string",
    "dataHoraReceita": "string",
    "filiaisPorSituacao": [
      {
        "quantidadeFiliais": 0,
        "situacao": "string"
      }
    ],
    "filiaisPorCnae": [
      {
        "quantidadeFiliais": 0,
        "cnae": "string"
      }
    ],
    "isInformacaoTagReceitaAtualizada": true,
    "cnpjMatriz": "string"
  },
  "quadroSocietario": [
    {
      "participacao": "string",
      "nome": "string",
      "documento": "string",
      "dataEntrada": "string",
      "dataSaida": "string",
      "cargoSociedade": "string",
      "cidade": "string",
      "uf": "string",
      "cep": "string",
      "alerta": true,
      "restricao": true
    }
  ],
  "pessoa": {
    "success": true,
    "message": "string",
    "cpf": "string",
    "nome": "string",
    "identidade": "string",
    "nomeMae": "string",
    "idade": "string",
    "situacaoCadastral": "string",
    "dataNascimento": "string",
    "rendaPresumida": "string",
    "mensagemErroRendaPresumida": "string",
    "escolaridade": "string",
    "nacionalidade": "string",
    "dataInscricao": "string",
    "dataHoraReceita": "string",
    "codigoControleReceita": "string",
    "dadosCadastrais": {
      "uf": "string",
      "cidade": "string",
      "complemento": "string",
      "endereco": "string",
      "numero": "string",
      "bairro": "string",
      "cep": "string"
    },
    "obito": {
      "obito": "string",
      "dataObito": "string",
      "nomeCartorio": "string"
    },
    "politicamenteExposta": {
      "funcao": "string",
      "orgao": "string",
      "dataInicioExercicio": "string",
      "cpf": "string",
      "nome": "string",
      "dataFimExercicio": "string"
    }
  },
  "vinculoEmpresa": {
    "success": true,
    "message": "string",
    "cbo": "string",
    "descricaoFuncao": "string",
    "dataAdmissao": "string",
    "pis": "string",
    "rendaEstimada": "string"
  },
  "contatoPrefencial": [
    {
      "whatsapp": "string",
      "telefone": "string",
      "cpfCnpj": "string",
      "nome": "string",
      "operadora": "string",
      "procon": "string",
      "cidade": "string",
      "uf": "string",
      "bairro": "string",
      "rua": "string",
      "numero": "string",
      "complemento": "string"
    }
  ],
  "participacaoEmpresa": [
    {
      "sucess": true,
      "message": "string",
      "nome": "string",
      "percentualParticipacao": "string",
      "cnpj": "string",
      "dataEntrada": "string",
      "cargo": "string",
      "endereco": "string",
      "cidade": "string",
      "bairro": "string",
      "cep": "string",
      "uf": "string",
      "numero": "string",
      "complemento": "string",
      "situacaoReceita": "string",
      "dataUltimaAtualizacao": "string",
      "restricao": true,
      "documentoSocio": "string",
      "nomeSocio": "string"
    }
  ],
  "suframa": {
    "success": true,
    "message": "string",
    "cnpj": "string",
    "inscricaoEstadual": "string",
    "inscricaoSuframa": "string",
    "inscricoesSuframa": [
      "string"
    ],
    "razaoSocial": "string",
    "logradouro": "string",
    "numero": "string",
    "complemento": "string",
    "bairro": "string",
    "cep": "string",
    "cidade": "string",
    "estado": "string",
    "telefone": "string",
    "enderecoEletronico": "string",
    "atividadeEconomica": "string",
    "tipoIncentivo": "string",
    "situacaoCadastral": "string",
    "dataValidade": "string",
    "isentaTSA": "string",
    "dataInscricao": "string",
    "dataConsulta": "string"
  },
  "sintegra": {
    "success": true,
    "message": "string",
    "cnpj": "string",
    "cpf": "string",
    "inscricaoEstadual": "string",
    "inscricoesEstaduais": [
      "string"
    ],
    "razaoSocial": "string",
    "nomeFantasia": "string",
    "logradouro": "string",
    "numero": "string",
    "complemento": "string",
    "bairro": "string",
    "cep": "string",
    "cidade": "string",
    "estado": "string",
    "telefone": "string",
    "enderecoEletronico": "string",
    "observacao": "string",
    "operacaoNFe": "string",
    "atividadeEconomica": "string",
    "cnae": "string",
    "cae": "string",
    "dataCredenciamentoNFE": "string",
    "obrigatoriedadeNFE": "string",
    "dataInicioObrigatoriedadeNFE": "string",
    "usuarioPed": "string",
    "dataPed": "string",
    "credenciamentoNFE": "string",
    "superSimples": "string",
    "regimeApuracao": "string",
    "credenciamento": "string",
    "regimePagamento": "string",
    "delegaciaFazendaria": "string",
    "naturezaJuridica": "string",
    "motivoInclusao": "string",
    "dataBaixa": "string",
    "motivoBaixa": "string",
    "situacaoCadastral": "string",
    "dataSituacaoCadastral": "string",
    "dataInscricaoEstadual": "string",
    "dataConsulta": "string",
    "numeroConsulta": "string"
  },
  "protestos": {
    "sucess": true,
    "message": "string",
    "quantidadeTotal": 0,
    "valorTotal": 0,
    "dataPrimeiro": "2023-12-02T10:28:06.371Z",
    "dataUltimo": "2023-12-02T10:28:06.371Z",
    "situacao": "string",
    "cartorios": [
      {
        "nome": "string",
        "endereco": "string",
        "uf": "string",
        "telefone": "string",
        "protestos": 0,
        "existeProtestoDetalhamento": true,
        "protesto": [
          {
            "data": "2023-12-02T10:28:06.371Z",
            "valor": 0
          }
        ]
      }
    ],
    "ultimasOcorrencias": [
      {
        "cartorio": "string",
        "uf": "string",
        "data": "2023-12-02T10:28:06.371Z",
        "valor": 0
      }
    ],
    "quantidadeProtestosInvalida": true
  },
  "emails": [
    "string"
  ],
  "outrosEnderecos": [
    {
      "endereco": "string",
      "numero": "string",
      "complemento": "string",
      "cep": "string",
      "uf": "string",
      "municipio": "string",
      "bairro": "string"
    }
  ],
  "score": {
    "success": true,
    "score": 0,
    "minScore": 0,
    "maxScore": 0,
    "motivos": [
      "string"
    ],
    "risco": "string",
    "descricao": "string",
    "erro": "string",
    "probabilidadePagamento": 0,
    "descricaoPagamento": "string"
  },
  "scoreCadastroPositivo": {
    "score": 0,
    "range": "string",
    "probabilidadePagamento": 0,
    "mensagem": "string",
    "success": true,
    "minScore": 0,
    "maxScore": 0,
    "erro": "string"
  },
  "inconsistenciasComerciais": {
    "success": true,
    "message": "string",
    "inconsistenciasComerciaisDetalhe": [
      {
        "descricaoAlerta": "string",
        "frase": "string",
        "data": "string"
      }
    ]
  },
  "limiteEstimado": {
    "success": true,
    "message": "string",
    "dataCalculo": "2023-12-02T10:28:06.371Z",
    "valor": 0,
    "observacao": "string"
  },
  "historicoDePagamento": {
    "success": true,
    "erro": "string",
    "totalDeCompromissos": {
      "classificacaoDaFaixa": "string",
      "valorInicialFaixa": 0,
      "valorFinalFaixa": 0,
      "percentualAVista": 0,
      "percentualParcelado": 0
    },
    "pontualidadeDePagamento": {
      "classificacaoDaFaixa": "string",
      "valorInicialFaixa": 0,
      "valorFinalFaixa": 0,
      "percentualPontual": 0,
      "percentualAtraso": 0
    },
    "mensagemDeNaoRetorno": {
      "mensagem": "string"
    }
  },
  "consultas": {
    "contagemUltimos15Dias": 0,
    "contagemUltimos30Dias": 0,
    "contagemUltimos31a60Dias": 0,
    "contagemUltimos61a90Dias": 0,
    "contagem90DiasMais": 0,
    "detalhes": [
      {
        "dataConsulta": "string",
        "quantidadeConsultas": 0,
        "segmento": "string"
      }
    ],
    "success": true,
    "erro": "string",
    "message": "string"
  },
  "indicadores": {
    "success": true,
    "message": "string",
    "codigoErro": "string",
    "grupoIndicadores": [
      {
        "nomeGrupoIndicador": "string",
        "itensGrupoIndicador": [
          {
            "nomeGrupoIndicador": "string",
            "codigo": "string",
            "valor": "string",
            "mensagem": "string",
            "valorMinimo": 0,
            "valorMaximo": 0,
            "descricao": "string",
            "nome": "string",
            "tipoExibicao": 1
          }
        ]
      }
    ]
  },
  "documentosRoubados": {
    "success": true,
    "message": "string",
    "documentosRoubados": [
      {
        "tipoDocumento": "string",
        "numeroDocumento": "string",
        "motivoOcorrencia": "string",
        "dataOcorrencia": "string",
        "mensagem": "string"
      }
    ]
  },
  "participacaoEmFalencia": {
    "success": true,
    "message": "string",
    "participacaoEmFalenciaDetalhe": [
      {
        "dataOcorrencia": "string",
        "documentoEmpresa": "string",
        "nomeEmpresa": "string",
        "totalOcorrenciasCpf": "string"
      }
    ]
  },
  "scr": {
    "success": true,
    "message": "string",
    "vencimentosConsolidados": {
      "informacaoConsulta": [
        {
          "descricao": "string",
          "valor": "string"
        }
      ],
      "itensAVencer": {
        "descricaoTotal": "string",
        "valorTotal": 0,
        "percentualTotal": "string",
        "itens": [
          {
            "descricao": "string",
            "valor": 0,
            "percentual": "string"
          }
        ]
      },
      "itensVencidos": {
        "descricaoTotal": "string",
        "valorTotal": 0,
        "percentualTotal": "string",
        "itens": [
          {
            "descricao": "string",
            "valor": 0,
            "percentual": "string"
          }
        ]
      }
    },
    "vencimentoPorModalidade": {
      "vencimentoPorModalidades": [
        {
          "descricaoTotal": "string",
          "valorTotal": 0,
          "percentualTotal": "string",
          "itens": [
            {
              "descricao": "string",
              "valor": 0,
              "percentual": "string"
            }
          ]
        }
      ],
      "carteiraAtiva": {
        "descricao": "string",
        "valor": 0,
        "percentual": "string"
      },
      "prejuizo": {
        "descricaoTotal": "string",
        "valorTotal": 0,
        "percentualTotal": "string",
        "itens": [
          {
            "descricao": "string",
            "valor": 0,
            "percentual": "string"
          }
        ]
      },
      "carteiraCredito": {
        "descricao": "string",
        "valor": 0,
        "percentual": "string"
      },
      "repasseInterfinanceiro": {
        "descricaoTotal": "string",
        "valorTotal": 0,
        "percentualTotal": "string",
        "itens": [
          {
            "descricao": "string",
            "valor": 0,
            "percentual": "string"
          }
        ]
      },
      "coobrigacao": {
        "descricaoTotal": "string",
        "valorTotal": 0,
        "percentualTotal": "string",
        "itens": [
          {
            "descricao": "string",
            "valor": 0,
            "percentual": "string"
          }
        ]
      },
      "responsabilidadeTotal": {
        "descricao": "string",
        "valor": 0,
        "percentual": "string"
      },
      "creditoLiberar": {
        "descricaoTotal": "string",
        "valorTotal": 0,
        "percentualTotal": "string",
        "itens": [
          {
            "descricao": "string",
            "valor": 0,
            "percentual": "string"
          }
        ]
      },
      "limiteCredito": {
        "descricaoTotal": "string",
        "valorTotal": 0,
        "percentualTotal": "string",
        "itens": [
          {
            "descricao": "string",
            "valor": 0,
            "percentual": "string"
          }
        ]
      },
      "riscoIndireto": {
        "descricao": "string",
        "valor": 0,
        "percentual": "string"
      },
      "riscoAssumido": {
        "descricao": "string",
        "valor": 0,
        "percentual": "string"
      },
      "riscoTotal": {
        "descricao": "string",
        "valor": 0,
        "percentual": "string"
      },
      "coobrigacaoRecebida": {
        "descricao": "string",
        "valor": 0,
        "percentual": "string"
      }
    }
  },
  "smart": {
    "success": true,
    "message": "string",
    "classificacao": {
      "classificacao": "string",
      "limiteSugerido": 0,
      "limiteRequisitado": 0,
      "validade": "2023-12-02T10:28:06.371Z",
      "pontuacaoAtingida": 0,
      "politicaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "politica": "string",
      "ticketMedio": 0,
      "porte": "string"
    },
    "positivas": [
      {
        "metrica": "string",
        "descricao": "string",
        "pontuacao": 0,
        "impacto": 0,
        "percentualMetrica": 0
      }
    ],
    "negativas": [
      {
        "metrica": "string",
        "descricao": "string",
        "pontuacao": 0,
        "impacto": 0,
        "percentualMetrica": 0
      }
    ],
    "todasClassificacoes": [
      {
        "nome": "string",
        "pontuacaoAtingida": 0,
        "limiteExigido": 0,
        "multiplicadorArranque": 0,
        "validade": 0,
        "limiteMinimo": 0,
        "limiteMaximo": 0
      }
    ],
    "dadosComplementares": {
      "informacaoAdicional": "string",
      "dataPosicao": "2023-12-02T10:28:06.371Z",
      "contasReceberResumido": {
        "mediaDiasAtraso": 0,
        "mediaDiasVencido": 0,
        "mediaDiasVencer": 0,
        "totalPago": 0,
        "totalVencido": 0,
        "totalVencer": 0
      },
      "campoComplementar": 0,
      "maiorLimiteTomado": 0,
      "documento": "string",
      "contasReceberDetalhado": {
        "resumo": {
          "valorTotal": 0,
          "quantidadeTotal": 0,
          "valorPagos": 0,
          "quantidadePagos": 0,
          "valorVencidos": 0,
          "quantidadeVencidos": 0,
          "valorVencer": 0,
          "quantidadeVencer": 0,
          "dataMaisAntigo": "2023-12-02T10:28:06.371Z",
          "dataMaisRecente": "2023-12-02T10:28:06.371Z",
          "mediaDiasVencido": 0,
          "mediaDiasAtraso": 0,
          "mediaDiasVencer": 0
        },
        "titulos": [
          {
            "codigoTitulo": "string",
            "numeroTitulo": "string",
            "dataEmissao": "2023-12-02T10:28:06.371Z",
            "dataVencimento": "2023-12-02T10:28:06.371Z",
            "dataPagamento": "2023-12-02T10:28:06.371Z",
            "valor": 0,
            "saldo": 0
          }
        ]
      },
      "crPorDocumento": [
        "string"
      ]
    },
    "parecer": {
      "aprovado": true,
      "limiteRequisitado": 0,
      "resultadoParecer": [
        {
          "nome": "string",
          "atendido": true,
          "percentual": 0,
          "percentualEsperado": 0,
          "regras": [
            {
              "descricao": "string",
              "motivo": "string",
              "formula": "string",
              "pontuacao": 0,
              "atendido": true,
              "obrigatorio": true
            }
          ]
        }
      ]
    }
  },
  "faturamentoPresumido": {
    "success": true,
    "message": "string",
    "faturamentoPresumido": "string",
    "valor": 0
  },
  "referenciaisNegocio": {
    "success": true,
    "message": "string",
    "referenciaisNegocioDetalhe": [
      {
        "descricao": "string",
        "ano": "string",
        "mes": "string",
        "codigoFaixaValor": "string",
        "descricaoFaixaValor": "string",
        "valorDe": 0,
        "valorAte": 0,
        "codigoFaixaMedia": "string",
        "descricaoFaixaMedia": "string",
        "mediaDe": 0,
        "mediaAte": 0
      }
    ]
  },
  "relacionamentoMercado": {
    "success": true,
    "message": "string",
    "dtAtualizacao": "string",
    "indiceRelacionamentoMercado": "string",
    "relacionamentoMercadoSetor": [
      {
        "setor": "string",
        "grauRelacionamento": "string",
        "mensagem": "string"
      }
    ]
  },
  "analiseRisco": {
    "success": true,
    "message": "string",
    "pontualidade": {
      "conceito": "string",
      "indicadores": [
        {
          "descricaoIndicador": "string",
          "indicador": "string",
          "descricao": "string",
          "codigo": "string",
          "semInformacao": true,
          "pontuacao": 0,
          "pontuacaoMax": 0,
          "pontuacaoMin": 0,
          "conceitos": [
            0
          ],
          "parecer": "string"
        }
      ],
      "semInformacao": true,
      "pontuacao": 0,
      "pontuacaoMax": 0,
      "pontuacaoMin": 0,
      "conceitos": [
        "string"
      ],
      "parecer": "string"
    },
    "solidez": {
      "conceito": "string",
      "indicadores": [
        {
          "descricaoIndicador": "string",
          "indicador": "string",
          "descricao": "string",
          "codigo": "string",
          "semInformacao": true,
          "pontuacao": 0,
          "pontuacaoMax": 0,
          "pontuacaoMin": 0,
          "conceitos": [
            0
          ],
          "parecer": "string"
        }
      ],
      "semInformacao": true,
      "pontuacao": 0,
      "pontuacaoMax": 0,
      "pontuacaoMin": 0,
      "conceitos": [
        "string"
      ],
      "parecer": "string"
    },
    "grauAtividadeEconomica": "string",
    "risco": "string",
    "faturamentoPresumido": "string",
    "rendaPresumida": "string",
    "semInformacao": true,
    "pontuacao": 0,
    "pontuacaoMax": 0,
    "pontuacaoMin": 0,
    "conceitos": [
      "string"
    ],
    "parecer": "string",
    "mensagem": "string"
  },
  "historicoConsultaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "linkCompartilhamento": "string",
  "grupoComponentes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "situacao": "string",
      "documento": "string",
      "razaoSocial": "string",
      "linkCompartilhamento": "string",
      "blocosComErros": [
        "string"
      ],
      "parecer": 0
    }
  ],
  "rendaPresumidaGastoEstimado": {
    "success": true,
    "message": "string",
    "rendaPresumida": "string",
    "gastoMedioTotal": "string",
    "comprometimentoTotal": "string",
    "cartaoCreditoTotal": "string",
    "comprometimentoCartaoCreditoTotal": "string",
    "gastoMedioParcelados": "string",
    "comprometimentoParcelados": "string",
    "financiamentoImovel": "string",
    "financiamentoVeiculo": "string"
  },
  "restricoesCheques": {
    "alertas": [
      {
        "data": "string",
        "mensagem": "string"
      }
    ],
    "alertasV2": {
      "success": true,
      "erro": "string",
      "mensagem": "string",
      "quantidade": 0,
      "alertas": [
        {
          "data": "string",
          "mensagem": "string"
        }
      ]
    },
    "chequesDevolvidosSemFundo": {
      "success": true,
      "erro": "string",
      "mensagem": "string",
      "totalCheques": 0,
      "totalNomesRelacionados": 0,
      "ocorrencias": [
        {
          "nome": "string",
          "dataUltimo": "2023-12-02T10:28:06.372Z",
          "numeroBanco": "string",
          "nomeBanco": "string",
          "agencia": "string",
          "motivo": "string",
          "quantidade": 0
        }
      ]
    },
    "chequesDevolvidosOutrosMotivos": {
      "success": true,
      "erro": "string",
      "mensagem": "string",
      "totalCheques": 0,
      "totalNomesRelacionados": 0,
      "ocorrencias": [
        {
          "nome": "string",
          "dataUltimo": "2023-12-02T10:28:06.372Z",
          "numeroBanco": "string",
          "nomeBanco": "string",
          "agencia": "string",
          "motivo": "string",
          "quantidade": 0
        }
      ]
    },
    "chequesSustados": {
      "success": true,
      "mensagem": "string",
      "total": 0,
      "periodoInicial": "2023-12-02T10:28:06.372Z",
      "periodoFinal": "2023-12-02T10:28:06.372Z",
      "ultimasOcorrencias": [
        {
          "data": "2023-12-02T10:28:06.372Z",
          "banco": "string",
          "agencia": "string",
          "cheques": "string",
          "dataOcorrencia": "2023-12-02T10:28:06.372Z"
        }
      ]
    },
    "chequesDevolvidosInformadosUsuario": {
      "success": true,
      "mensagem": "string",
      "quantidadeTotal": 0,
      "periodoInicial": "2023-12-02T10:28:06.372Z",
      "periodoFinal": "2023-12-02T10:28:06.372Z",
      "ultimasOcorrencias": [
        {
          "informante": "string",
          "banco": "string",
          "agencia": "string",
          "chequesInicial": "string",
          "chequesFinal": "string",
          "dataOcorrencia": "2023-12-02T10:28:06.372Z",
          "dataRegistro": "2023-12-02T10:28:06.372Z",
          "motivo": "string",
          "cidade": "string",
          "uf": "string"
        }
      ]
    }
  },
  "pendenciasRestricoes": {
    "mensagem": "string",
    "totalPendencias": 0,
    "totalCredores": 0,
    "valor": 0,
    "periodoInicial": "2023-12-02T10:28:06.372Z",
    "periodoFinal": "2023-12-02T10:28:06.372Z",
    "valorPrimeiro": 0,
    "dataPrimeiro": "2023-12-02T10:28:06.372Z",
    "valorMaior": 0,
    "dataMaior": "2023-12-02T10:28:06.372Z",
    "nivel": "string",
    "success": true,
    "erro": "string",
    "ocorrencias": [
      {
        "informante": "string",
        "tipo": "string",
        "cidade": "string",
        "uf": "string",
        "documentoOrigem": "string",
        "dataDebito": "2023-12-02T10:28:06.372Z",
        "disponivelEm": "2023-12-02T10:28:06.372Z",
        "valor": 0,
        "tipoParticipante": "string",
        "numeroContrato": "string"
      }
    ]
  },
  "acoesCiveis": {
    "mensagem": "string",
    "totalAcoes": 0,
    "valorTotal": 0,
    "valorPrimeiro": 0,
    "dataPrimeiro": "2023-12-02T10:28:06.372Z",
    "valorMaior": 0,
    "dataMaior": "2023-12-02T10:28:06.372Z",
    "success": true,
    "erro": "string",
    "ocorrencias": [
      {
        "requerido": "string",
        "acao": "string",
        "documento": "string",
        "foro": "string",
        "uf": "string",
        "vara": "string",
        "autor": "string",
        "processo": "string",
        "distribuicao": "2023-12-02T10:28:06.372Z",
        "valor": 0,
        "comarca": "string",
        "valorExecucao": 0,
        "dataAutuacao": "2023-12-02T10:28:06.372Z",
        "dataArquivamento": "2023-12-02T10:28:06.372Z",
        "justicaGratuita": "string",
        "segmento": "string",
        "situacao": "string",
        "julgamentos": [
          {
            "dataJulgamento": "2023-12-02T10:28:06.372Z",
            "statusJulgamento": "string",
            "diasAteJulgamento": 0,
            "tipoJulgamento": "string"
          }
        ],
        "assuntosCnj": [
          "string"
        ]
      }
    ]
  },
  "falenciasRecuperacaoJudicial": {
    "success": true,
    "erro": "string",
    "mensagem": "string",
    "quantidadeTotal": 0,
    "periodoInicial": "2023-12-02T10:28:06.372Z",
    "periodoFinal": "2023-12-02T10:28:06.372Z",
    "ultimasOcorrencias": [
      {
        "tipoOcorrencia": "string",
        "data": "2023-12-02T10:28:06.372Z",
        "cidade": "string",
        "uf": "string",
        "vara": "string",
        "processo": "string"
      }
    ]
  },
  "quadroSocietarioV2": {
    "success": true,
    "comParticipacao": true,
    "message": "string",
    "quadroSocietario": [
      {
        "participacao": "string",
        "nome": "string",
        "documento": "string",
        "dataEntrada": "string",
        "dataSaida": "string",
        "cargoSociedade": "string",
        "cidade": "string",
        "uf": "string",
        "cep": "string",
        "alerta": true,
        "restricao": true
      }
    ]
  },
  "contatoPreferencialV2": {
    "success": true,
    "message": "string",
    "contatoPrefencial": [
      {
        "whatsapp": "string",
        "telefone": "string",
        "cpfCnpj": "string",
        "nome": "string",
        "operadora": "string",
        "procon": "string",
        "cidade": "string",
        "uf": "string",
        "bairro": "string",
        "rua": "string",
        "numero": "string",
        "complemento": "string"
      }
    ]
  },
  "participacaoEmpresaV2": {
    "success": true,
    "message": "string",
    "participacaoEmpresa": [
      {
        "sucess": true,
        "message": "string",
        "nome": "string",
        "percentualParticipacao": "string",
        "cnpj": "string",
        "dataEntrada": "string",
        "cargo": "string",
        "endereco": "string",
        "cidade": "string",
        "bairro": "string",
        "cep": "string",
        "uf": "string",
        "numero": "string",
        "complemento": "string",
        "situacaoReceita": "string",
        "dataUltimaAtualizacao": "string",
        "restricao": true,
        "documentoSocio": "string",
        "nomeSocio": "string"
      }
    ]
  },
  "relacaoEmpresaParticipacaoSocioV2": {
    "success": true,
    "message": "string",
    "relacaoEmpresaParticipacaoSocio": [
      {
        "sucess": true,
        "message": "string",
        "nome": "string",
        "percentualParticipacao": "string",
        "cnpj": "string",
        "dataEntrada": "string",
        "cargo": "string",
        "endereco": "string",
        "cidade": "string",
        "bairro": "string",
        "cep": "string",
        "uf": "string",
        "numero": "string",
        "complemento": "string",
        "situacaoReceita": "string",
        "dataUltimaAtualizacao": "string",
        "restricao": true,
        "documentoSocio": "string",
        "nomeSocio": "string"
      }
    ]
  }
}

# Tabela de campos do retorno da Mix 📊

Clique para exibir os detalhes da tabela com o descritivo.

Campos do retorno	Descrição
{
"consultante": "string",	Nome do Consultante
"produto": "string",	Nome do produto consultado
"usuario": "string",	Nome do usuário que efetuou a consulta
"versao": "string",	Versão utilizada da Mix
"isParcial": boolean,	Consulta parcial
"isGrupo": boolean,	identifica se é uma análise de grupo econômico
"dataConsulta": date,	Data que a consulta foi efetuada
"blocosComErros": [	Estrutura que apresenta blocos com erros
"string"	Retorno do tipo string
],
"empresa": {	Dados da Empresa
"success": boolean,
"message": "string",
"cnpj": "string",	CNPJ consultado
"tipoUnidade": "string",	Tipo Consultado
"razaoSocial": "string",	Razão social
"nomeFantasia": "string",	Nome fantasia
"situacaoCadastral": "string",	Situação Cadastral
"dataSituacaoCadastral": "string",	Data da Situação cadastral
"dataInicioAtividade": "string",	Data inicio Atividade
"dataInicioAtividadeMatriz": "string",	Só é alimentado quando o documento consultado seja filial
"motivoSituacaoCadastral": "string",	Motivo da Situação cadastral
"naturezaJuridica": "string",	Natureza juridica
"cnaePrincipal": "string",	CNAE principal
"cnaesSecundarios": [	Estrutura que lista Cnaes secundários
"string"	Retorno do tipo string
],
"endereco": "string",	Endereço
"numero": "string",	Número
"bairro": "string",	Bairro
"complemento": "string",	Complemento
"cep": "string",	CEP
"uf": "string",	UF
"municipio": "string",	Município
"municipioCodigoIbge": "string",	Código do município no IBGE
"qualificacaoResponsavel": "string",	Qualificação do Responsável
"capitalSocialEmpresa": "string",	Valor do capital social da empresa
"faturamentoPresumido": "string",	Valor de faturamento presumido da empresa
"porte": "string",	Porte da Empresa
"quantidadeFuncionarios": "string",	Quantidade de funcionários
"opcaoPeloSimples": "string",	Retorna se a empresa é optante pelo regime Simples Nacional ou não. “NÃO OPTANTE” e “OPTANTE PELO SIMPLES”
"dataOpcaoPeloSimples": "string",	Data da opção pelo Simples Nacional
"dataExclusaoOpcaoPeloSimples": "string",	Data da exclusão no regime Simples Nacional
"opcaoMei": "string",	Retorna se a empresa é do tipo MEI
"situacaoEspecial": "string",	Situação especial da empresa
"dataSituacaoEspecial": "string",	Data da situação especial
"nomeEnteFederativo": "string",	Nome do ente federativo
"quantidadeFiliais": "string",	Quantidade de filiais da empresa
"possuiRestricao": "string",	Retorna se o documento possui restrição ou não
"nire": "string",	Número de identificação do registro de empresas
"otimizaSemInformacao": true,	Retorno booleano da consulta otimiza
"erro": "string",	Mensagem de erro
"dataHoraReceita": "string",	Data Hora Receita
"filiaisPorSituacao": [	Estrutura com a quantidade de filiais por situação
{
"quantidadeFiliais": number,	Quantidade de filiais
"situacao": "string"	Situação da filial
}
],
"filiaisPorCnae": [	Estrutura com a quantidade de filiais por CNAE
{
"quantidadeFiliais": number,	Quantidade de filiais
"cnae": "string"	Descrição do CNAE
}
],
"isInformacaoTagReceitaAtualizada": boolean,
"cnpjMatriz": "string"	Retorno do tipo string
},
"quadroSocietario": [	Estrutura referente ao quadro societário da empresa
{
"participacao": "string",	Porcentagem de participação
"nome": "string",	Nome do sócio
"documento": "string",	Documento do sócio
"dataEntrada": "string",	Data de entrada na sociedade
"dataSaida": "string",	Data de saída na sociedade
"cargoSociedade": "string",	Cargo do sócio
"cidade": "string",	Cidade
"uf": "string",	UF
"cep": "string",	CEP
"alerta": boolean,	Retorna se o componente do quadro societário possui divergência
"restricao": boolean
}
],
"pessoa": {	Estrutura referente às informações de pessoa física
"success": true,
"message": "string",
"cpf": "string",	CPF
"nome": "string",	Nome completo
"identidade": "string",	Identidade
"nomeMae": "string",	Nome completo da mãe
"idade": "string",	Idade
"situacaoCadastral": "string",	Situação cadastral
"dataNascimento": "string",	Data de nascimento
"rendaPresumida": "string",	Renda presumida
"mensagemErroRendaPresumida": "string",	Retorna mensagem de erro
"escolaridade": "string",	Escolaridade
"nacionalidade": "string",	Nacionalidade
"dataInscricao": "string",
"dataHoraReceita": "string",
"codigoControleReceita": "string",
"dadosCadastrais": {	Estrutura referente aos dados cadastrais
"uf": "string",
"cidade": "string",
"complemento": "string",
"endereco": "string",
"numero": "string",
"bairro": "string",
"cep": "string",
},
"obito": {	Estrutura referente às informações de registro de óbito
"obito": "string",	Descrição
"dataObito": "string",	Data do óbito
"nomeCartorio": "string"	Nome do cartório em que foi registrado
},
"politicamenteExposta": {	Estrutura referente às informações caso a pessoa seja politicamente exposta
"funcao": "string",	Função
"orgao": "string",	Órgão
"dataInicioExercicio": "string",	Data de início do exercício
"cpf": "string",	CPF
"nome": "string",	Nome completo
"dataFimExercicio": "string"	Data final do exercício
}
},
"vinculoEmpresa": {	Estrutura referente às informações de vínculo com empresa
"success": boolean,
"message": "string",
"cbo": "string",	Código CBO
"descricaoFuncao": "string",	Descrição da função
"dataAdmissao": "string",	Data de admissão
"pis": "string",	Número do PIS
"rendaEstimada": "string"	Renda estimada
},
"contatoPrefencial": [	Estrutura referente às informações de contato preferencial
{
"whatsapp": "string",	Número do whatsapp
"telefone": "string",	Telefone
"cpfCnpj": "string",	CPF ou CNPJ
"nome": "string",	Nome do contato
"operadora": "string",	Operadora
"procon": "string",	Informação referente ao PROCON
"cidade": "string",	Cidade do contato
"uf": "string",	Estado do contato
"bairro": "string",	Bairro do contato
"rua": "string",	Rua do contato
"numero": "string",	Número de endereço do contato
"complemento": "string"	Complemento de endereço do contato
}
],
"participacaoEmpresa": [	Estrutura referente às informações de participações da empresa
{
"sucess": boolean,
"message": "string",
"nome": "string",	Nome do participante
"percentualParticipacao": "string",	Percentual de participação
"cnpj": "string",	CNPJ
"dataEntrada": "string",	Data de entrada como participante
"cargo": "string",	Cargo
"endereco": "string",	Endereço do participante
"cidade": "string",	Cidade do participante
"bairro": "string",	Bairro do participante
"cep": "string",	CEP do participante
"uf": "string",	Estado do participante
"numero": "string",	Número de endereço do participante
"complemento": "string",	Complemento de endereço do participante
"situacaoReceita": "string",	Situação do participante na Receita
"dataUltimaAtualizacao": "string",	Data da última atualização
"restricao": boolean,
"documentoSocio": "string"
"nomeSocio": "string"
}
],
"suframa": {	Estrutura referente aos dados da consulta Suframa
"success": boolean,
"message": "string",
"cnpj": "string",	CNPJ
"inscricaoEstadual": "string",	Inscrição estadual
"inscricaoSuframa": "string",	Inscrição do Suframa
"inscricoesSuframa": [	Estrutura referente às demais inscrições do Suframa vinculadas ao documento
"string"	Retorno do tipo string
],
"razaoSocial": "string",	Razão social
"logradouro": "string",	Logradouro
"numero": "string",	Número do Endereço
"complemento": "string",	Complemento
"bairro": "string",	Bairro
"cep": "string",	CEP
"cidade": "string",	Cidade
"estado": "string",	UF
"telefone": "string",	Telefone
"enderecoEletronico": "string",	E-mail
"atividadeEconomica": "string",	Atividade Econômica
"tipoIncentivo": "string",	Tipo de incentivo
"situacaoCadastral": "string",	Situação cadastral no Suframa
"dataValidade": "string",	Data de validade da inscrição
"isentaTSA": "string",	Retorna se o CNPJ é isento da taxa TSA
"dataInscricao": "string",	Data de inscrição no Suframa
"dataConsulta": "string"	Data da consulta realizada no Portal Deps
},
"sintegra": {	Estrutura referente aos dados da consulta Sintegra
"success": boolean,
"message": "string",
"cnpj": "string",	CNPJ
"cpf": "string",	CPF
"inscricaoEstadual": "string",	Inscrição estadual
"inscricoesEstaduais": [	Estrutura referente às demais inscrições estaduais vinculadas ao documento
"string"	Retorno do tipo string
],
"razaoSocial": "string",	Razão social
"nomeFantasia": "string",	Nome fantasia
"logradouro": "string",	Logradouro
"numero": "string",	Número do endereço
"complemento": "string",	Complemento do endereço
"bairro": "string",	Bairro
"cep": "string",	CEP
"cidade": "string",	Cidade
"estado": "string",	Estado
"telefone": "string",	Telefone do documento consultado
"enderecoEletronico": "string",	Email do documento consultado
"observacao": "string",	Observação do Sintegra
"operacaoNFe": "string",	Retorna se o cliente está habilitado ou não para emitir NF-e
"atividadeEconomica": "string",	Atividade econômica da empresa
"cnae": "string",	CNAE principal
"cae": "string",	Cadastro de atividade econômica
"dataCredenciamentoNFE": "string",	Data de credenciamento NF-e
"obrigatoriedadeNFE": "string",	Retorna se a empresa tem obrigatoriedade de emissão de notas fiscais eletrônicas. Exemplos de retorno: - “EMPRESA OBRIGADA A EMISSAO” - “EMPRESA OBRIGADA A EMISSAO EM dd/MM/aaaa” - “SIM”
"dataInicioObrigatoriedadeNFE": "string",	Data de início da obrigatoriedade NF-e
"usuarioPed": "string",	Usuário referente ao processamento eletrônico de dados
"dataPed": "string",	Data referente ao processamento eletrônico de dados
"credenciamentoNFE": "string",	Status do credenciamento NF-e
"superSimples": "string",	Dado referente ao Super Simples
"regimeApuracao": "string",	Regime de apuração da empresa
"credenciamento": "string",	Dado referente ao credenciamento da empresa
"regimePagamento": "string",	Descrição sobre o regime de pagamento
"delegaciaFazendaria": "string",	Descrição da Delegacia da Receita Estadual da região
"naturezaJuridica": "string",	Natureza jurídica da empresa
"motivoInclusao": "string",	Motivo da inclusão no Sintegra
"dataBaixa": "string",	Data da baixa no Sintegra
"motivoBaixa": "string",	Motivo da baixa no Sintegra
"situacaoCadastral": "string",	Situação cadastral
"dataSituacaoCadastral": "string",	Data da situação cadastral
"dataInscricaoEstadual": "string",	Data da inscrição estadual
"dataConsulta": "string",	Data da consulta realizada no Portal Deps
"numeroConsulta": "string"	Número da consulta realizada no Portal Deps
},
"protestos": {	Estrutura referente aos dados de protestos encontrados
"sucess": boolean,	Retorno booleano do sucesso da requisição
"message": "string",	Mensagem de retorno da requisição
"quantidadeTotal": number,	Quantidade de protestos encontrados
"valorTotal": number,	Valor de todos os protestos encontrados
"dataPrimeiro": date,	Data do primeiro protesto
"dataUltimo": date,	Data do último protesto
"situacao": "string",	Situação do protesto
"cartorios": [	Estrutura referente aos dados dos cartórios
{
"nome": "string",	Nome do cartório
"endereco": "string",	Endereço do cartório
"uf": "string",	Estado do cartório
"telefone": "string",	Telefone do cartório
"protestos": number,	Quantidade de protestos encontrados no cartório
"existeProtestoDetalhamento": boolean,
"protesto": [	Estrutura referente aos dados dos protestos encontrados no cartório
{
"data": date,	Data do protesto
"valor": number	Valor do protesto
}
]
}
],
"ultimasOcorrencias": [	Estrutura com as últimas ocorrências de protestos encontradas
{
"cartorio": "string",	Nome do cartório
"uf": "string",	Estado
"data": date,	Data do protesto
"valor": number	Valor do protesto
}
]
},
"emails": [	Estrutura referente aos demais emails encontrados
"string"	Retorno do tipo string
],
"outrosEnderecos": [	Estrutura referente aos outros endereços do consultado
{
"endereco": "string",	Endereço
"numero": "string",	Número do endereço
"complemento": "string",	Complemento do endereço
"cep": "string",	CEP
"uf": "string",	Estado
"municipio": "string",	Município
"bairro": "string"	Bairro
}
],
"score": {	Estrutura referente aos dados de Score
"success": boolean,	Sucesso da requisição caso encontre a informação
"score": number,	Valor do score
"minScore": number,	Valor mínimo do score
"maxScore": number,	Valor máximo do score
"motivos": [	Estrutura referente aos motivos do score
"string"	Retorno do tipo string
],
"risco": "string",	Risco de não pagamento
"descricao": "string",	Descrição do score
"erro": "string",	Campo de erro proveniente do provedor
"probabilidadePagamento": number,	Valor referente à probabilidade de pagamento
"descricaoPagamento": "string",	Descrição da probabilidade de pagamento
"scoreCadastroPositivo": {	Estrutura do score cadastro positivo
"score": number,
"range": "string",
"probabilidadePagamento": number,
"mensagem": "string",
"success": boolean,
"minScore": number,
"maxScore": number,
"erro": "string"
},
"inconsistenciasComerciais": {	Estrutura refentente às inconsistências comerciais
"success": boolean,
"message": "string",
"inconsistenciasComerciaisDetalhe": [	Estrutura dos detalhes das inconsistências comerciais
{
"descricaoAlerta": "string",
"frase": "string",
"data": "string"
}
]
},
"limiteEstimado": {	Estrutura do limite estimado
"success": boolean,
"message": "string",
"dataCalculo": date,
"valor": number,
"observacao": "string"
},
"historicoDePagamento": {	Estrutura do histórico de pagamento
"success": boolean,
"erro": "string",
"totalDeCompromissos": {	Estrutura do total de compromissos
"classificacaoDaFaixa": "string",
"valorInicialFaixa": number,
"valorFinalFaixa": number,
"percentualAVista": number,
"percentualParcelado": number
},
"pontualidadeDePagamento": {	Estrutura da pontualidade de pagamento
"classificacaoDaFaixa": "string",
"valorInicialFaixa": number,
"valorFinalFaixa": number,
"percentualPontual": number,
"percentualAtraso": number
},
"mensagemDeNaoRetorno": {
"mensagem": "string"
}
},
"consultas": {	Estrutura referente aos dados de consultas Quod realizadas
"contagemUltimos15Dias": number,
"contagemUltimos30Dias": number,	Quantidade de consultas realizadas em 30 dias
"contagemUltimos31a60Dias": number,	Quantidade de consultas realizadas entre 31 e 60 dias
"contagemUltimos61a90Dias": number,	Quantidade de consultas realizadas entre 61 e 90 dias
"contagem90DiasMais": number,	Quantidade de consultas realizadas há mais de 90 dias
"detalhes": [	Estrutura referente aos detalhes das consultas realizadas
{
"dataConsulta": "string",	Data da consulta
"quantidadeConsultas": number,	Quantidade de consultas
"segmento": "string"	Segmento
}
],
"success": boolean,
"erro": "string",
"message": "string"
},
"indicadores": {	Estrutura dos indicadores
"success": boolean,
"message": "string",
"grupoIndicadores": [	Estrutura do grupo de indicadores
{
"nomeGrupoIndicador": "string",
"itensGrupoIndicador": [	Estrutura dos itens do grupo de indicadores
{
"nomeGrupoIndicador": "string",
"codigo": "string",
"valor": "string",
"mensagem": "string",
"valorMinimo": number,
"valorMaximo": number,
"descricao": "string",
"nome": "string",
"tipoExibicao": number
}
]
}
]
},
"documentosRoubados": {	Retorna caso o produto contenha esse bloco e o documento consultado
"success": boolean,
"message": "string",
"documentosRoubados": [
{
"tipoDocumento": "string",
"numeroDocumento": "string",
"motivoOcorrencia": "string",
"dataOcorrencia": "string",
"mensagem": "string"
}
]
},
"participacaoEmFalencia": {
"success": boolean,
"message": "string",
"participacaoEmFalenciaDetalhe": [	Estrutura dos detalhes da participação em falência
{
"dataOcorrencia": "string",
"documentoEmpresa": "string",
"nomeEmpresa": "string",
"totalOcorrenciasCpf": "string"
}
]
},
"scr": {	Estrutura referente ao SCR
"success": boolean,
"message": "string",
"vencimentosConsolidados": {	Estrutura dos vencimentos consolidados do SCR
"informacaoConsulta": [
{
"descricao": "string",
"valor": "string"
}
],
"itensAVencer": {
"descricaoTotal": "string",
"valorTotal": number,
"percentualTotal": "string",
"itens": [	Estrutura referente aos itens à vencer
{
"descricao": "string",
"valor": number,
"percentual": "string"
}
]
},
"itensVencidos": {
"descricaoTotal": "string",
"valorTotal": number,
"percentualTotal": "string",
"itens": [
{
"descricao": "string",
"valor": number,
"percentual": "string"
}
]
}
},
"vencimentoPorModalidade": {
"vencimentoPorModalidades": [	Estrutura referente aos vencimentos por modalidades
{
"descricaoTotal": "string",
"valorTotal": 0,
"percentualTotal": "string",
"itens": [
{
"descricao": "string",
"valor": number,
"percentual": "string"
}
]
}
],
"carteiraAtiva": {	Estrutura referente a carteira ativa
"descricao": "string",
"valor": number,
"percentual": "string"
},
"prejuizo": {	Estrutura referente ao prejuízo
"descricaoTotal": "string",
"valorTotal": number,
"percentualTotal": "string",
"itens": [
{
"descricao": "string",
"valor": number,
"percentual": "string"
}
]
},
"carteiraCredito": {
"descricao": "string",
"valor": number,
"percentual": "string"
},
"repasseInterfinanceiro": {	Estrutura referente ao repasse interfinanceiro
"descricaoTotal": "string",
"valorTotal": number,
"percentualTotal": "string",
"itens": [
{
"descricao": "string",
"valor": number,
"percentual": "string"
}
]
},
"coobrigacao": {	Estrutura referente à coobrigação
"descricaoTotal": "string",
"valorTotal": number,
"percentualTotal": "string",
"itens": [
{
"descricao": "string",
"valor": number,
"percentual": "string"
}
]
},
"responsabilidadeTotal": {	Estrutura referente à responsabilidade total
"descricao": "string",
"valor": number,
"percentual": "string"
},
"creditoLiberar": {	Estrutura referente ao crédito a liberar
"descricaoTotal": "string",
"valorTotal": number,
"percentualTotal": "string",
"itens": [
{
"descricao": "string",
"valor": number,
"percentual": "string"
}
]
},
"limiteCredito": {
"descricaoTotal": "string",
"valorTotal": number,
"percentualTotal": "string",
"itens": [
{
"descricao": "string",
"valor": number,
"percentual": "string"
}
]
},
"riscoIndireto": {	Estrutura referente ao risco indireto
"descricao": "string",
"valor": number,
"percentual": "string"
},
"riscoAssumido": {	Estrutura referente ao risco assumido
"descricao": "string",
"valor": number,
"percentual": "string"
},
"riscoTotal": {	Estrutura referente ao risco total
"descricao": "string",
"valor": number,
"percentual": "string"
},
"coobrigacaoRecebida": {	Estrutura referente à coobrigação recebida
"descricao": "string",
"valor": number,
"percentual": "string"
}
}
},
"smart": {	Retona dados da Análise caso seu produto possua esse bloco
"success": boolean,
"message": "string",
"classificacao": {	Dados referente a classificação
"classificacao": "string",	Classificação do CNPJ consultado
"limiteSugerido": number,	Limite sugerido com base na análise realizada
"validade": date,	Validade da Classificação
"pontuacaoAtingida": number,	Pontuação atingida da política
"politicaId": string,	ID da política associada ao produto
"politica": "string",	Política analisada
"ticketMedio": number,	Valor do ticket médio
"porte": "string"
},
"positivas": [	Métricas pontuadas como positivas
{
"metrica": "string",	Métrica
"descricao": "string",	Descrição
"pontuacao": number,	Pontuação atingida
"impacto": number,	Impacto na política
"percentualMetrica": number	Percentual atingido da métrica
}
],
"negativas": [	Métricas pontuadas como negativas
{
"metrica": "string",	Nome da Métrica
"descricao": "string",	Descrição da Métrica
"pontuacao": number,	Pontuação atingida
"impacto": number,	Impacto na política
"percentualMetrica": number	Percentual atingido da métrica
}
],
"todasClassificacoes": [	Lista todas as Classificações
{
"nome": "string",	Nome da Classificação
"pontuacaoAtingida": number,	Pontuação Atingida
"limiteExigido": number,	Limite exigido para classificação
"multiplicadorArranque": number,	Multiplicador de arranque
"validade": number,	Validade
"limiteMinimo": number,	Limite mínimo
"limiteMaximo": number	Limite máximo
}
],
"dadosComplementares": {	Informações de dados complementares contas a receber
"informacaoAdicional": "string",	Informações adicionais
"dataPosicao": date,	Data da posição
"contasReceberResumido": {	Estrutura referente ao contas receber resumido
"mediaDiasAtraso": number,	Média de dias de atraso
"mediaDiasVencido": number,	Média de dias vencido
"mediaDiasVencer": number,	Média de dias à vencer
"totalPago": number,	Valor total pago
"totalVencido": number,	Valor total vencido
"totalVencer": number	Valor total à vencer
},
"campoComplementar": number,
"maiorLimiteTomado": number,	Valor do maior limite tomado
"documento": "string",	Número do documento do contas a receber
"contasReceberDetalhado": {	Estrutura do contas a receber detalhado
"resumo": {	Estrutura referente ao resumido com contas a receber detalhado
"valorTotal": number,
"quantidadeTotal": number,
"valorPagos": number,
"quantidadePagos": number,
"valorVencidos": number,
"quantidadeVencidos": number,
"valorVencer": number,
"quantidadeVencer": number,
"dataMaisAntigo": date,
"dataMaisRecente": date,
"mediaDiasVencido": number,
"mediaDiasAtraso": number,
"mediaDiasVencer": number,
},
"titulos": [	Estrutura referente aos títulos do contas a receber detalhado
{
"codigoTitulo": "string",
"numeroTitulo": "string",
"dataEmissao": date,
"dataVencimento": date,
"dataPagamento": date,
"valor": number,
"saldo": number
}
]
},
"crPorDocumento": [
"string"	Retorno do tipo string
]
},
"parecer": {	Estrutura refente ao Parecer de aprovação
"aprovado": boolean,	Retorna se o Parecer foi aprovado ou não
"limiteRequisitado": number,	Retorna valor informado no limite requisitado
"resultadoParecer": [	Estrutura referente aos resultados das regras do Parecer
{
"nome": "string",	Nome do Parecer
"atendido": boolean,	Retorna se o Parecer foi ou não atendido
"percentual": number,	Retorna o percentual atingido do Parecer
"percentualEsperado": number,	Retorna o percentual esperado do Parecer
"regras": [	Estrutura referente às regras do Parecer
{
"descricao": "string",	Nome da regra do Parecer
"motivo": "string",	Retorna o motivo da regra não estar aprovada
"formula": "string",	Retorna a fórmula vinculada à regra do Parecer
"pontuacao": number,	Retorna a pontuação da regra do Parecer
"atendido": boolean,	Retorna se a regra do Parecer foi ou não atendida
"obrigatorio": true	Retorna se a regra do Parecer é ou não obrigatória
}
]
}
]
}
},
"faturamentoPresumido": {	Estrutura de faturamento presumido
"success": boolean,
"message": "string",
"faturamentoPresumido": "string",	Faixa do faturamento presumido
"valor": number
},
"referenciaisNegocio": {
"success": boolean,
"message": "string",
"referenciaisNegocioDetalhe": [
{
"descricao": "string",
"ano": "string",
"mes": "string",
"codigoFaixaValor": "string",
"descricaoFaixaValor": "string",
"valorDe": number,
"valorAte": number,
"codigoFaixaMedia": "string",
"descricaoFaixaMedia": "string",
"mediaDe": number,
"mediaAte": number
}
]
},
"relacionamentoMercado": {
"success": true,
"message": "string",
"dtAtualizacao": "string",
"indiceRelacionamentoMercado": "string",
"relacionamentoMercadoSetor": [
{
"setor": "string",
"grauRelacionamento": "string",
"mensagem": "string"
}
]
},
"analiseRisco": {	Estrutura referente à análise de risco
"success": boolean,
"message": "string",
"pontualidade": {	Estrutura referente à pontualidade
"conceito": "string",
"indicadores": [
{
"descricaoIndicador": "string",
"indicador": "string",
"descricao": "string",
"codigo": "string",
"semInformacao": boolean,
"pontuacao": number,
"pontuacaoMax": number,
"pontuacaoMin": number,
"conceitos": [
number
],
"parecer": "string"
}
],
"parecer": "string"
}
],
"semInformacao": true,
"pontuacao": number,
"pontuacaoMax": number,
"pontuacaoMin": number,
"conceitos": [
"string"
],
"parecer": "string"
},
"solidez": {	Estrutura referente à solidez
"conceito": "string",
"indicadores": [
{
"descricaoIndicador": "string",
"indicador": "string",
"descricao": "string",
"codigo": "string",
"semInformacao": boolean,
"pontuacao": number,
"pontuacaoMax": number,
"pontuacaoMin": number,
"conceitos": [
number	Retorna um number
],
"parecer": "string"
}
],
"semInformacao": boolean,
"pontuacao": number,
"pontuacaoMax": number,
"pontuacaoMin": number,
"conceitos": [
"string"
],
"parecer": "string"
},
"grauAtividadeEconomica": "string",
"risco": "string",
"faturamentoPresumido": "string",
"rendaPresumida": "string",
"semInformacao": boolean,
"pontuacao": number,
"pontuacaoMax": number,
"pontuacaoMin": number,
"conceitos": [
"string"	Retorno do tipo string
],
"parecer": "string",
"mensagem": "string"
"historicoConsultaId": ID,	Retorna o ID do histórico de consulta criado quando realizado a consulta
"linkCompartilhamento": "string",
"grupoComponentes": [
{
"id": ID,	Retorna o ID do grupo de componentes
"situacao": "string",
"documento": "string",
"razaoSocial": "string",
"linkCompartilhamento": "string",
"blocosComErros": [
"string"	Retorno do tipo string
],
"parecer": 0
}
],
"rendaPresumidaGastoEstimado": {	Estrutura referente ao bloco Renda presumida com gasto estimado
"success": boolean,
"message": "string",
"rendaPresumida": "string",	Retorna a renda presumida do documento consultado
"gastoMedioTotal": "string",
"comprometimentoTotal": "string",
"cartaoCreditoTotal": "string",
"comprometimentoCartaoCreditoTotal": "string",
"gastoMedioParcelados": "string",
"comprometimentoParcelados": "string",
"financiamentoImovel": "string",	Retorna se possui financiamento de imóvel
"financiamentoVeiculo": "string"	Retorna se possui financiamento de veículo
},
"restricoesCheques": {
"alertasV2": {	Estrutura referente aos alertas BACEN
"success": true,
"erro": "string",
"mensagem": "string",
"quantidade": number,
"alertas": [
{
"data": "string",
"mensagem": "string"
}
]
},
"chequesDevolvidosSemFundo": {	Estrutura com as informações de cheques devolvidos
"success": boolean,
"erro": "string",
"mensagem": "string",	Mensagem de erro
"totalCheques": 0,	total de cheques
"totalNomesRelacionados": 0,	Quantidade de nomes relacionados
"ocorrencias": [
{
"nome": "string",
"dataUltimo": date,	Data da última ocorrência
"numeroBanco": "string",	Número do banco
"nomeBanco": "string",	nome do banco
"agencia": "string",	Agência do banco
"motivo": "string",	Motivo do cheque
"quantidade": number	Quantidade
}
]
},
"historicoConsultaId": "string",	Id do histórico de consulta
"linkCompartilhamento": "string",	Link gerado pelo Portal para compartilhar a visualização da consulta
"restricoesCheques": {	Estrutura com as informações de restrição do Banco Central
"alertas": [	Estrutura com as informações de alertas
{
"data": "string",	Data do Alerta
"mensagem": "string"	Mensagem do alerta
}
],
"chequesDevolvidosOutrosMotivos": {	Estrutura com as informações de cheques
"success": true,
"erro": "string",
"mensagem": "string",
"totalCheques": 0,	Total Cheques
"totalNomesRelacionados": 0,
"ocorrencias": [
{
"nome": "string",
"dataUltimo": date,	Data último
"numeroBanco": "string",	Número do banco
"nomeBanco": "string",	Nome do banco
"agencia": "string",	Agência
"motivo": "string",	Motivo da devolução
"quantidade": 0	Quantidade de cheques
}
]
},
"chequesSustados": {	Estrutura com as informações de cheques sustados
"success": true,
"mensagem": "string",
"total": number,	Quantidade total de cheques sustados
"periodoInicial": date,
"periodoFinal": date,
"ultimasOcorrencias": [
{
"data": date,
"banco": "string",
"agencia": "string",
"cheques": "string",
"dataOcorrencia": date
}
]
},
"chequesDevolvidosInformadosUsuario": {	Estrutura referente aos cheques devolvidos informados pelo usuário
"success": boolean,
"mensagem": "string",
"quantidadeTotal": number,
"periodoInicial": date,
"periodoFinal": date,
"ultimasOcorrencias": [
{
"informante": "string",
"banco": "string",
"agencia": "string",
"chequesInicial": "string",
"chequesFinal": "string",
"dataOcorrencia": date,
"dataRegistro": date,
"motivo": "string",
"cidade": "string",
"uf": "string"
}
]
}
},
"pendenciasRestricoes": {	Estrutura de pendências e restrições
"mensagem": "string",
"totalPendencias": number,	Total de pendências
"totalCredores": number,	Total de Credores
"valor": number,	Valor das pendências
"periodoInicial": date,
"periodoFinal": date,
"valorPrimeiro": number,	Valor da primeira pendência
"dataPrimeiro": date,
"valorMaior": number,	Valor da maior pendência
"dataMaior": date,
"nivel": "string",
"success": boolean,
"erro": "string",
"ocorrencias": [
{
"informante": "string",	Informante
"tipo": "string",	Tipo da ocorrência
"cidade": "string",	Cidade
"uf": "string",	UF
"documentoOrigem": "string",	Documento origem
"dataDebito": date,	Data débito
"disponivelEm": date,
"valor": number,	Valor da ocorrência
"tipoParticipante": "string",	Tipo participante
"numeroContrato": "string"	Número contrato
}
]
},
"acoesCiveis": {	Estrutura de ações
"mensagem": "string",
"totalAcoes": number,	Total de ações
"valorTotal": number,	Valor total
"valorPrimeiro": number,	Valor do primeiro
"dataPrimeiro": date,	Data do primeiro
"valorMaior": number,	Valor do maior
"dataMaior": date,	Data do maior
"success": boolean,
"erro": "string",
"ocorrencias": [
{
"requerido": "string",	Requerido
"acao": "string",	Ação
"documento": "string",	Documento
"foro": "string",	Foro
"uf": "string",	UF
"vara": "string",	Vara
"autor": "string",	Autor
"processo": "string",
"distribuicao": date,
"valor": number,	Valor da ação
"comarca": "string"	Comarca
"valorExecucao": number,
"dataAutuacao": date,
"dataArquivamento": date,
"justicaGratuita": "string",
"segmento": "string",
"situacao": "string",
"julgamentos": [
{
"dataJulgamento": date,
"statusJulgamento": "string",
"diasAteJulgamento": number,
"tipoJulgamento": "string"
}
],
"assuntosCnj": [
"string"	Retorno do tipo string
]
}
]
},
"falenciasRecuperacaoJudicial": {	Estrutura de Falencia e Recuperação
"success": boolean,
"erro": "string",
"mensagem": "string",
"quantidadeTotal": number,	Quantidade total
"periodoInicial": date,
"periodoFinal": date,
"ultimasOcorrencias": [
{
"tipoOcorrencia": "string",	Tipo de ocorrência
"data": date,
"cidade": "string",	Cidade
"uf": "string",	UF
"vara": "string",	Vara
"processo": "string"	Número do processo
}
]
},
"quadroSocietarioV2": {
"success": boolean,
"comParticipacao": boolean,
"message": "string",
"quadroSocietario": [
{
"participacao": "string",
"nome": "string",
"documento": "string",
"dataEntrada": "string",
"dataSaida": "string",
"cargoSociedade": "string",
"cidade": "string",
"uf": "string",
"cep": "string",
"alerta": boolean,	Quando retornar true indica que encontramos alteração no quadro societário.
"restricao": boolean
}
]
},
"contatoPreferencialV2": {
"success": boolean,
"message": "string",
"contatoPrefencial": [
{
"whatsapp": "string",
"telefone": "string",
"cpfCnpj": "string",
"nome": "string",
"operadora": "string",
"procon": "string",
"cidade": "string",
"uf": "string",
"bairro": "string",
"rua": "string",
"numero": "string",
"complemento": "string"
}
]
},
"participacaoEmpresaV2": {
"success": boolean,
"message": "string",
"participacaoEmpresa": [
{
"sucess": boolean,
"message": "string",
"nome": "string",
"percentualParticipacao": "string",
"cnpj": "string",
"dataEntrada": "string",
"cargo": "string",
"endereco": "string",
"cidade": "string",
"bairro": "string",
"cep": "string",
"uf": "string",
"numero": "string",
"complemento": "string",
"situacaoReceita": "string",
"dataUltimaAtualizacao": "string",
"restricao": boolean
"documentoSocio": "string",
"nomeSocio": "string"
}
]
}
},
"relacaoEmpresaParticipacaoSocioV2": {
"success": boolean,
"message": "string",
"relacaoEmpresaParticipacaoSocio": [
{
"sucess": boolean,
"message": "string",
"nome": "string",
"percentualParticipacao": "string",
"cnpj": "string",
"dataEntrada": "string",
"cargo": "string",
"endereco": "string",
"cidade": "string",
"bairro": "string",
"cep": "string",
"uf": "string",
"numero": "string",
"complemento": "string",
"situacaoReceita": "string",
"dataUltimaAtualizacao": "string",
"restricao": boolean,
"documentoSocio": "string",
"nomeSocio": "string"
}
]
}
}

# Análise de Grupo Econômico

Para realizar a análise de grupo econômico é necessário ter as informações do grupo, ou seja, dados dos componentes do grupo econômico. Com base nos dados, será feita a análise do grupo, nesse caso deve ser enviado os documentos que fazem parte do grupo para que a análise seja realizada.

Para realizar uma consulta de grupo econômico é necessário que o cliente possua contrato ativo para o produto Smart, seja ele PF ou PJ, dependendo do que se deseja consultar.

Importante!

Cada consulta efetuada gera custos.

Método: POST
Endpoint da consulta: https://api-portal.deps.com.br/api/v3/consultas/depsmix-grupo

Deve informar na requisição todos os documentos que fazem parte do grupo econômico e o identificador do produto que deseja consultar.

Posso enviar um documento CPF e um CNPJ? Se possuir no contrato esses produtos e políticas configuradas pode.

Caso você não saiba quem são os componentes do grupo, recomendamos fazer uma consulta do CNPJ primeiro que deseja analisar com um produto que possua dados de participações e sócios no endponit da depsmix e depois com esses dados utilizar esses documentos, para o envio no endpoint da análise em grupo.

Clique para exibir o corpo da requisição

{
  "componentes": [
    {
      "documento": "string",
      "identificadorProduto": "string",
      "reutilizarDadosExistentes": false
    }
  ]
}

Campos do JSON:

Campo	Descrição
documento	Informar o documento (sem pontuações) que se deseja consultar
identificadorProduto	Informar o identificador de 8 caracteres do produto contratado no Portal Deps
reutilizarDadosExistentes	Informar se deseja reutilizar dados existentes na base ou não. Se o valor for igual a false, então será realizada uma nova consulta Se o valor for igual a true, o Portal verificará se existe alguma consulta na base para o mesmo produto e documento. Caso possua, então reutiliza os mesmos dados, caso contrário o documento será desconsiderado na análise de grupo econômico

# Configurações do header e parâmetros de entrada - Homologação ⚙️

Após ter obtido o token de autenticação, é necessário a configuração do header e dos parâmetros de entrada.
A consulta deverá ser consumida pelo seguinte endpoint:

 https://homologacao-portal.deps.com.br/api/v1/conta/entrar

Clique para exibir o header da requisição.

    Content-Type: application/json
    Authorization: Bearer token

Usuário e senha homologação:

Login: [email protected]
Senha: deps

Login e senha de homologação não funcionam em produção.

Produto para homologação informar: AAAAA

Clique para exibir os documentos para teste em homologação:

Documentos PJ:

79001989000108 - Smart (completa)
31640420000166 - Smart com parecer
53359929000178 - Mix (completa)
Documentos PF: 88136193169 - Mix PF
76278847647 - Mix PF (Analise risco)
36536120477 - Smart PF

O ambiente de homologação é utilizado como base para avaliar o consumo de consultas

# Exemplo consumo da API 👩‍💻

Segue exemplo em C# para consumo da api.

Clique para exibir exemplo de consumo.


// See https://aka.ms/new-console-template for more information

using Newtonsoft.Json.Linq;
using System.Net.Http.Headers;
using System.Net.Http.Json;

var endpointApi = "https://homologacao-portal.deps.com.br/";

//Para consumir a API de produção basta utilizar a variável abaixo no lugar do "endpointApi"
var endpointApiProducaoV3 = "https://api-portal.deps.com.br/api/v3/";

var httpClient = new HttpClient();
httpClient.BaseAddress = new Uri(endpointApi);

//Realizar login e buscar o token
var data = JsonContent.Create(new
{
    email = "[email protected]",
    senha = "deps"
});

var response = await httpClient.PostAsync("conta/entrar", data);
if (!response.IsSuccessStatusCode)
    throw new Exception("Erro ao obter token");

var json = JObject.Parse(await response.Content.ReadAsStringAsync());
var token = json.GetValue("access_token").Value<string>();

//Realizar consulta passando o token

httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);

var dataConsulta = JsonContent.Create(new
{
    dadosComplementaresAnalise = new
    {
        dataPosicao = DateTime.Now,
        contasReceberResumido = new
        {
            mediaDiasAtraso = 0,
            mediaDiasVencido = 0,
            mediaDiasVencer = 0,
            totalPago = 0,
            totalVencido = 0,
            totalVencer = 0
        }
    }
});

var documento = "05284733000119";
var identificadorProduto = "AAAAAA";
var query = $"?documento={documento}&identificadorProduto={identificadorProdutor&reutilizarDadosExistentes=false";

var responseConsulta = await httpClient.PostAsync($"consultas/depsmix{query}", dataConsulta);
if (!responseConsulta.IsSuccessStatusCode)
    throw new Exception("Erro ao consultar");


Console.WriteLine(await responseConsulta.Content.ReadAsStringAsync());

# Dúvidas frequentes

# Como devo enviar o Contas a Receber?

O envio do contas a receber pode ser em um momento anterior a consulta ou no momento em que realizar a consulta:

Antes de realizar a consulta:

Contas a receber resumido:

Endpoint POST: https://analise.deps.com.br/api/v1/contas-receber (opens new window)

Contas a receber detalhado:

Endpoint POST: https://contas-receber.deps.com.br/api/v1/contas-receber/detalhado (opens new window)

Quando é realizada a chamada da consulta:

Endpoint POST: https://api-portal.deps.com.br/api/v3/consultas/depsmix (opens new window)

Dica!

Você pode enviar as informações do contas a receber no campo de dados complementares, no link desta documentação você pode ver todos os parâmetros que podem ser enviados ao fazer a consulta, ou se preferir pode verificar diretamente o Swagger (opens new window).

Caso você não tenha verificado a documentação da API do contas a receber você pode acessar pelo Swagger ou clicando aqui

Dica!

Caso você deseje verificar o manual do contas a receber basta clicar aqui.

# Como solicitar uma nova consulta a partir dos dados atualizados?

Caso tenha optado por enviar o contas a receber no momento anterior a consulta, basta realizar a consulta no endpoint:

 https://api-portal.deps.com.br/api/v3/consultas/depsmix

Que ele já irá buscar as informações que foram enviadas no contas a receber e retornará as informações da consulta, como limite sugerido, classificação, e outras informações.

O objeto que é retornado aqui é similar ao objeto que temos no ambiente de homologação.

# Como consultar os dados da última consulta?

A consulta já é retornada no momento em que ela é realizada, ou seja, a requisição é de forma síncrona

# O envio do contas a receber para validação, onde verifico?

Sugerimos que o envio do contas a receber seja já em produção onde pode ser conferido pelos usuarios. Depois de homologado o contas a receber, basta nos solicitar a limpeza das informações.