Deps Documentação

# Documentação da API

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 adiquirido no PortalDeps, pode não contemplar determinados bloco de consulta.

# O que você encontrará neste manual 📙

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

A consulta abrange as seguintes informações:

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

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

# 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/v1/conta/entrar
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,
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "nome": "string",
    "email": "string",
    "telefone": "string",
    "ativo": 0,
    "clienteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "permissao": "string"
  }
}
Clique para exibir a resposta com erro (400 - Bad Request) ❌ 
{
  "codigo": "string",
  "mensagem": "string"
}

# 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 Sim
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
limiteRequisitado double Solicitação de Limite para Smart analisar Não
version integer Refere-se à versão da API Mix. Informar o valor = 2. Sim

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/v2/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.

Clique para exibir o corpo da requisição POST da consulta Mix: 
{
  "dadosComplementaresAnalise": {
    "dataPosicao": "2023-08-14T12:14:58.381Z",
    "contasReceberResumido": {
      "mediaDiasAtraso": 0,
      "mediaDiasVencido": 0,
      "mediaDiasVencer": 0,
      "totalPago": 0,
      "totalVencido": 0,
      "totalVencer": 0
    },
    "campoComplementar": 0,
    "maiorLimiteTomado": 0,
    "contasReceberDetalhado": {
      "tipoDetalhado": "string",
      "dataInicio": "2023-08-14T12:14:58.381Z",
      "dataFim": "2023-08-14T12:14:58.381Z",
      "titulos": [
        {
          "codigoTitulo": "string",
          "numeroTitulo": "string",
          "dataEmissao": "2023-08-14T12:14:58.381Z",
          "dataVencimento": "2023-08-14T12:14:58.381Z",
          "dataPagamento": "2023-08-14T12:14:58.381Z",
          "valor": 0,
          "saldo": 0
        }
      ]
    }
  },
  "autorizacaoConsulta": {
    "documento": "string",
    "nome": "string",
    "email": "string",
    "emailUsuario": "string"
  },
  "inscricaoEstadual": "string"
}
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
}

# 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

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 medias devem ser enviadas valor 0. Valores negativos serão considerados como 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.

Endpoint POST: https://contas-receber.deps.com.br/api/v1/contas-receber/detalhado

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 primaria/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
}
]
}
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 primaria/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.

# 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:

img

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

img

Dica 💡

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

# Parecer de Aprovação de cadastro 📑

O parecer é um check list que não só aponta inconsistências, mas também gera um parecer claro. O Parecer de Aprovação transforma dados em decisões acionáveis, com um parecer que pode ser "Aprovado" para aqueles que atendem aos critérios, "Reprovado" para os que não estão em conformidade. Junto com o parecer é possível requisitar um limite de crédito através do parâmetros de entrada. O Portal irá analisar as regras do Parecer junto do limite sugerido no Diagnóstico da Smart e exibirá se o limite requisitado foi aprovado ou não.

Para conhecer um pouco mais sobre o parecer clique aqui ou fale com nosso atendimento.

Essas funcionalidades só estão disponíveis para produto Smart.

Clique para visualizar parecer na Smart. 
 "parecer": {
      "aprovado": true,
      "motivo": "string",
      "limiteRequisitado": 0,
      "resultadoParecer": [
        {
          "nome": "string",
          "atendido": true,
          "percentual": 0,
          "percentualEsperado": 0,
          "regras": [
            {
              "descricao": "string",
              "motivo": "string",
              "formula": "string",
              "pontuacao": 0,
              "atendido": true,
              "obrigatorio": true
            }
          ]
        }
      ]
    }
Clique para visualizar parecer na Smart com exemplo. 

    "parecer": {
      "aprovado": true,
      "motivo": "",
      "limiteRequisitado": 1000,
      "resultadoParecer": [
        {
          "nome": "Fat",
          "atendido": true,
          "percentual": 100,
          "percentualEsperado": 100,
          "regras": [
            {
              "descricao": "Faturamento presumido maior ou igual que R$ 10.000,00",
              "motivo": "",
              "formula": null,
              "pontuacao": 0,
              "atendido": true,
              "obrigatorio": true
            }
          ]
        },
        {
          "nome": "Cadastro",
          "atendido": true,
          "percentual": 100,
          "percentualEsperado": 100,
          "regras": [
            {
              "descricao": "Fundação maior ou igual que 1 mes(es)",
              "motivo": "",
              "formula": null,
              "pontuacao": 0,
              "atendido": true,
              "obrigatorio": true
            },
            {
              "descricao": "Situação receita contém Ativa",
              "motivo": "",
              "formula": null,
              "pontuacao": 0,
              "atendido": true,
              "obrigatorio": true
            }
          ]
        }
      ]
    }
Clique para exibir os detalhes a tabela com o descritivo.
Campos do retorno Descrição
parecer
aprovado Situação do parecer
motivo Motivo do parecer
limiteRequisitado Valor do limite requisitado
resultadoParecer Resultado do parecer
nome Nome do parecer
atendido Situação do parecer
percentual Percentual atingido (configurado por pontuação)
percentualEsperado Percentual configurado para aprovação (não obrigatório)
regras Regras implementadas dentro do parecer
descricao Descrição da regra do parecer que está sendo validada
motivo Motivo da regra do parecer não aprovado
formula Fórmula utilizada (se aplicável)
pontuacao Valor da pontuação atingida
atendido Situação da regra do parecer (Verdadeiro ou Falso)
obrigatorio Indica se o parecer é obrigatório ou não

Para requisitar o limite de crédito enviar os paramêtros de entrada no campo limiterequisitado

# 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",
  "isParcial": true,
  "isGrupo": true,
  "dataConsulta": "2023-08-17T11:54:42.965Z",
  "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
    }
  ],
  "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-08-17T11:54:42.966Z",
    "dataUltimo": "2023-08-17T11:54:42.966Z",
    "situacao": "string",
    "cartorios": [
      {
        "nome": "string",
        "endereco": "string",
        "uf": "string",
        "telefone": "string",
        "protestos": 0,
        "existeProtestoDetalhamento": true,
        "protesto": [
          {
            "data": "2023-08-17T11:54:42.967Z",
            "valor": 0
          }
        ]
      }
    ],
    "ultimasOcorrencias": [
      {
        "cartorio": "string",
        "uf": "string",
        "data": "2023-08-17T11:54:42.967Z",
        "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-08-17T11:54:42.967Z",
    "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,
      "validade": "2023-08-17T11:54:42.967Z",
      "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-08-17T11:54:42.967Z",
      "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-08-17T11:54:42.967Z",
          "dataMaisRecente": "2023-08-17T11:54:42.967Z"
        },
        "titulos": [
          {
            "codigoTitulo": "string",
            "numeroTitulo": "string",
            "dataEmissao": "2023-08-17T11:54:42.968Z",
            "dataVencimento": "2023-08-17T11:54:42.968Z",
            "dataPagamento": "2023-08-17T11:54:42.968Z",
            "valor": 0,
            "saldo": 0
          }
        ]
      },
      "crPorDocumento": [
        "string"
      ]
    },
    "parecer": {
      "aprovado": true,
      "motivo": "string",
      "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",
    "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
    }
  ],
  "restricoesCheques": {
    "alertas": [
      {
        "data": "string",
        "mensagem": "string"
      }
    ],
    "alertasV2": {
      "success": true,
      "erro": "string",
      "mensagem": "string",
      "alertas": [
        {
          "data": "string",
          "mensagem": "string"
        }
      ]
    },
    "chequesDevolvidosSemFundo": {
      "success": true,
      "erro": "string",
      "mensagem": "string",
      "totalCheques": 0,
      "totalNomesRelacionados": 0,
      "ocorrencias": [
        {
          "nome": "string",
          "dataUltimo": "2023-08-17T11:54:42.968Z",
          "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-08-17T11:54:42.968Z",
          "numeroBanco": "string",
          "nomeBanco": "string",
          "agencia": "string",
          "motivo": "string",
          "quantidade": 0
        }
      ]
    },
    "chequesSustados": {
      "success": true,
      "mensagem": "string",
      "total": 0,
      "periodoInicial": "2023-08-17T11:54:42.968Z",
      "periodoFinal": "2023-08-17T11:54:42.968Z",
      "ultimasOcorrencias": [
        {
          "data": "2023-08-17T11:54:42.968Z",
          "banco": "string",
          "agencia": "string",
          "cheques": "string",
          "dataOcorrencia": "2023-08-17T11:54:42.968Z"
        }
      ]
    },
    "chequesDevolvidosInformadosUsuario": {
      "success": true,
      "mensagem": "string",
      "quantidadeTotal": 0,
      "periodoInicial": "2023-08-17T11:54:42.968Z",
      "periodoFinal": "2023-08-17T11:54:42.968Z",
      "ultimasOcorrencias": [
        {
          "informante": "string",
          "banco": "string",
          "agencia": "string",
          "chequesInicial": "string",
          "chequesFinal": "string",
          "dataOcorrencia": "2023-08-17T11:54:42.968Z",
          "dataRegistro": "2023-08-17T11:54:42.968Z",
          "motivo": "string",
          "cidade": "string",
          "uf": "string"
        }
      ]
    }
  },
  "pendenciasRestricoes": {
    "mensagem": "string",
    "totalPendencias": 0,
    "totalCredores": 0,
    "valor": 0,
    "periodoInicial": "2023-08-17T11:54:42.968Z",
    "periodoFinal": "2023-08-17T11:54:42.968Z",
    "valorPrimeiro": 0,
    "dataPrimeiro": "2023-08-17T11:54:42.968Z",
    "valorMaior": 0,
    "dataMaior": "2023-08-17T11:54:42.968Z",
    "nivel": "string",
    "success": true,
    "erro": "string",
    "ocorrencias": [
      {
        "informante": "string",
        "tipo": "string",
        "cidade": "string",
        "uf": "string",
        "documentoOrigem": "string",
        "dataDebito": "2023-08-17T11:54:42.968Z",
        "disponivelEm": "2023-08-17T11:54:42.968Z",
        "valor": 0,
        "tipoParticipante": "string",
        "numeroContrato": "string"
      }
    ]
  },
  "acoesCiveis": {
    "mensagem": "string",
    "totalAcoes": 0,
    "valorTotal": 0,
    "valorPrimeiro": 0,
    "dataPrimeiro": "2023-08-17T11:54:42.968Z",
    "valorMaior": 0,
    "dataMaior": "2023-08-17T11:54:42.968Z",
    "success": true,
    "erro": "string",
    "ocorrencias": [
      {
        "requerido": "string",
        "acao": "string",
        "documento": "string",
        "foro": "string",
        "uf": "string",
        "vara": "string",
        "autor": "string",
        "processo": "string",
        "distribuicao": "2023-08-17T11:54:42.968Z",
        "valor": 0,
        "comarca": "string"
      }
    ]
  },
  "falenciasRecuperacaoJudicial": {
    "success": true,
    "erro": "string",
    "mensagem": "string",
    "quantidadeTotal": 0,
    "periodoInicial": "2023-08-17T11:54:42.968Z",
    "periodoFinal": "2023-08-17T11:54:42.968Z",
    "ultimasOcorrencias": [
      {
        "tipoOcorrencia": "string",
        "data": "2023-08-17T11:54:42.968Z",
        "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
      }
    ]
  }
}

# Tabela de campos do retorno 📊

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
"isParcial": true, Consulta parcial
"blocosComErros": [ Estrutura que apresenta blocos com erros
"string"
],
"empresa": { Dados da Empresa
"success": true,
"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 Situacao cadastral
"dataInicioAtividade": "string", Data inicio Atividade
"dataInicioAtividadeMatriz": "string", Só é alimentado quando o documento consultado seja filial
"motivoSituacaoCadastral": "string", Motivo da Situacao cadastral
"naturezaJuridica": "string", Natureza juridica
"cnaePrincipal": "string", CNAE principal
"cnaesSecundarios": [ Estrutura que lista Cnaes secundarios
"string"
],
"endereco": "string", Endereço
"bairro": "string", Bairro
"numero": "string", Número
"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": 0, Quantidade de filiais
"situacao": "string" Situação da filial
}
],
"filiaisPorCnae": [ Estrutura com a quantidade de filiais por CNAE
{
"quantidadeFiliais": 0, Quantidade de filiais
"cnae": "string" Descrição do CNAE
}
],
"isInformacaoTagReceitaAtualizada": true
},
"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
"cargoSociedade": "string", Cargo do sócio
"cidade": "string", Cidade
"uf": "string", UF
"cep": "string", CEP
"restricao": true
}
],
"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
"escolaridade": "string", Escolaridade
"nacionalidade": "string", Nacionalidade
"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": true,
"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" Completo de endereço do contato
}
],
"participacaoEmpresa": [ Estrutura referente às informações de participações da empresa
{
"sucess": true,
"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": true
}
],
"depsShare": { Estrutura referente às informações da consulta Deps Share
"success": true,
"message": "string",
"dataConsulta": "2022-09-06T13:04:44.137Z",
"dadosAssociado": { Estrutura referente aos dados do associado
"confidencialPara": "string", Nome do CNPJ
"segmento": "string" Descrição do segmento da Share
},
"identificacao": { Estrutura referente aos dados de identificação do documento consultado
"nome": "string", Nome
"segmento": "string", Segmento
"dataUltimaAtualizacao": "2022-09-06T13:04:44.137Z", Data da última atualização
"documento": "string", Documento
"cidade": "string", Cidade
"uf": "string", Estado
"grupo": "string", Informa se o documento consultado faz parte de grupo econômico (Sim/Não)
"associados": 0, Quantidade de associados que enviaram informações
"tipoPessoa": "string"

“F” – Física

“J” – Jurídica

},
"relacionamento": [ Estrutura referente aos dados de relacionamento
{
"relacionamento": "string", Tipo de relacionamento
"quantidade": 0, Quantidade
"percentual": 0 Percentual
}
],
"dividas": [ Estrutura referente aos dados de dívidas
{
"tipoDivida": "string", Tipo de dívida
"quantidadeAssociados": 0, Quantidade de associados que contribuíram com informações de dívidas
"percentual": 0, Percentual da dívida
"quantidade": 0, Quantidade de dívidas
"dataPrimeiro": "2022-09-06T13:04:44.137Z", Data da primeira dívida
"dataUltimo": "2022-09-06T13:04:44.137Z", Data da última dívida
"totalVencido": 0, Valor total de dívidas vencidas
"totalVencidoConsultante": 0, Valor total de dívidas vencidas do consultante
"documento": "string" Documento
}
],
"ultimasConsultas": [ Estrutura com as últimas consultas realizadas na Share
{
"periodo": "string",

Período em que foi realizada a consulta. Exemplo de retorno:

- “Esta semana”

- “Média últimos 6 meses”

- Mai/2021

- Fev/2021

"quantidade": 0 Quantidade de consultas realizadas no período
}
],
"alertas": { Estrutura com os dados de alertas cadastrados
"alertasInativos": 0, Quantidade de alertas inativos
"alertas": [ Estrutura com as informações dos alertas
{
"gravidade": "string", Gravidade do alerta
"descricao": "string", Descrição do alerta
"data": "2022-09-06T13:04:44.137Z" Data de cadastro do alerta
}
]
},
"grafias": [ Estrutura referente às grafias
"string"
],
"dividasDetalhadas": [ Estrutura referente aos dados de detalhamento das dívidas
{
"documento": "string", Documento
"tipoDivida": "string", Tipo da dívida
"dataEmissao": "2022-09-06T13:04:44.137Z", Data de emissão da dívida
"dataVencimento": "2022-09-06T13:04:44.137Z", Data de vencimento da dívida
"dataProrrogacao": "2022-09-06T13:04:44.137Z", Data de prorrogação da dívida
"valor": 0, Valor da dívida
"saldo": 0 Saldo da dívida
}
],
"dividasTotalizadores": { Estrutura referente aos totalizadores das dívidas
"totalVencido": 0, Valor total de dívidas vencidas
"totalVencidoConsultante": 0, Valor total de dívidas vencidas do consultante
"quantidadeTotal": 0 Quantidade total de dívidas
},
"isGrupo": true Retorno booleano conforme o campo de grupo (Sim/Não)
},
"suframa": { Estrutura referente aos dados da consulta Suframa
"success": true,
"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"
],
"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 Economica
"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": true,
"message": "string",
"cnpj": "string", CNPJ
"inscricaoEstadual": "string", Inscrição estadual
"inscricoesEstaduais": [ Estrutura referente às demais inscrições estaduais vinculadas ao documento
"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": true, Retorno booleano do sucesso da requisição
"message": "string", Mensagem de retorno da requisição
"quantidadeTotal": 0, Quantidade de protestos encontrados
"valorTotal": 0, Valor de todos os protestos encontrados
"dataPrimeiro": "2022-09-06T13:04:44.137Z", Data do primeiro protesto
"dataUltimo": "2022-09-06T13:04:44.137Z", 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": 0, Quantidade de protestos encontrados no cartório
"existeProtestoDetalhamento": true,
"protesto": [ Estrutura referente aos dados dos protestos encontrados no cartório
{
"data": "2022-09-06T13:04:44.137Z", Data do protesto
"valor": 0 Valor do protesto
}
]
}
],
"ultimasOcorrencias": [ Estrutura com as últimas ocorrências de protestos encontradas
{
"cartorio": "string", Nome do cartório
"uf": "string", Estado
"data": "2022-09-06T13:04:44.137Z", Data do protesto
"valor": 0 Valor do protesto
}
]
},
"emails": [ Estrutura referente aos demais emails encontrados
"string"
],
"outrosEnderecos": [
{
"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": true, Sucesso da requisição caso encontre a informação
"score": 0, Valor do score
"minScore": 0, Valor mínimo do score
"maxScore": 0, Valor máximo do score
"motivos": [ Estrutura referente aos motivos do score
"string"
],
"risco": "string", Risco de não pagamento
"descricao": "string", Descrição do score
"erro": "string", Campo de erro proveniente do provedor
"probabilidadePagamento": 0, Valor referente à probabilidade de pagamento
"descricaoPagamento": "string", Descrição da probabilidade de pagamento
"indicador": {
"message": "string",
"indicadores": [
{
"nomeGrupoIndicador": "string",
"codigo": "string",
"valor": "string",
"mensagem": "string",
"valorMinimo": 0,
"valorMaximo": 0,
"descricao": "string",
"nome": "string",
"tipoExibicao": 1
}
]
}
},
"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": "2022-09-06T13:04:44.137Z",
"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": { Estrutura referente aos dados de consultas Quod realizadas
"contagemUltimos15Dias": 0,
"contagemUltimos30Dias": 0, Quantidade de consultas realizadas em 30 dias
"contagemUltimos31a60Dias": 0, Quantidade de consultas realizadas entre 31 e 60 dias
"contagemUltimos61a90Dias": 0, Quantidade de consultas realizadas entre 61 e 90 dias
"contagem90DiasMais": 0, Quantidade de consultas realizadas há mais de 90 dias
"detalhes": [ Estrutura referente aos detalhes das consultas Quod realizadas
{
"dataConsulta": "string", Data da consulta
"quantidadeConsultas": 0, Quantidade de consultas
"segmento": "string" Segmento
}
],
"success": true,
"erro": "string",
"message": "string"
},
"indicadores": {
"success": true,
"message": "string",
"grupoIndicadores": [
{
"nomeGrupoIndicador": "string",
"itensGrupoIndicador": [
{
"nomeGrupoIndicador": "string",
"codigo": "string",
"valor": "string",
"mensagem": "string",
"valorMinimo": 0,
"valorMaximo": 0,
"descricao": "string",
"nome": "string",
"tipoExibicao": 1
}
]
}
]
},
"documentosRoubados": { Retorna caso o produto contenha esse bloco e o documento consultado
"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": { Retonar dados da Análise caso seu produto possua esse bloco
"success": true,
"message": "string",
"classificacao": { Dados referente a classificação
"classificacao": "string", Classificaçao do CNPJ consultado
"limiteSugerido": 0, Limite sugerido com base na análise realizda
"validade": "2022-09-06T13:04:44.138Z", Validade da Classificação
"pontuacaoAtingida": 0, Pontucação atingida da política
"politicaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"politica": "string", Política analisada
"ticketMedio": 0, Valor do ticket médio
"porte": "string"
},
"positivas": [ Métricas pontudas como positivos
{
"metrica": "string", Metrica
"descricao": "string", Descrição
"pontuacao": 0, Pontuação atingida
"impacto": 0 Impacto na política
}
],
"negativas": [ Métricas pontudas como
{
"metrica": "string", Nome da Métrica
"descricao": "string", Descrição da Métrica
"pontuacao": 0, Pontuação atingida
"impacto": 0 Impacto na política
}
],
"todasClassificacoes": [ Lista todas as Classificações
{
"nome": "string", Nome da Classificação
"pontuacaoAtingida": 0, Pontuação Atingida
"limiteExigido": 0, Limite exigido para classificação
"multiplicadorArranque": 0, Multiplicador de arranque
"validade": 0, Validade
"limiteMinimo": 0, Limite mínimo
"limiteMaximo": 0 Limite maxímo
}
],
"dadosComplementares": { Informações de dados complementares contas a receber
"dataPosicao": "2022-09-06T13:04:44.138Z", Data da posição
"contasReceberResumido": { Informações do contas receber resumido
"mediaDiasAtraso": 0, Média de dias de atraso
"mediaDiasVencido": 0, Média de dias vencido
"mediaDiasVencer": 0, Média de dias a Vencer
"totalPago": 0, Valor total pago
"totalVencido": 0, Valor total vencido
"totalVencer": 0 Valor total a vencer
},
"campoComplementar": 0,
"maiorLimiteTomado": 0, Valor do maior limite tomado
"contasReceberDetalhado": [ Informações enviadas do Contas receber detalhado
{
"tipo": 1,
"detalhes": [ Detalhes do contas a receber
{
"dataBase": "2022-09-06T13:04:44.138Z", Data base
"itens": [
{
"periodo": "string", Período
"valor": 0 Valor no período
}
]
}
]
}
]
}
},
"faturamentoPresumido": { Estrutura de faturamento presumido
"success": true,
"message": "string",
"faturamentoPresumido": "string" Faixa do faturamento presumido
},
"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"
}
]
},
"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
}
],
"alertasV2": {
"success": true,
"erro": "string",
"alertas": [
{
"data": "string",
"mensagem": "string"
}
]
},
"chequesDevolvidosSemFundo": { Estrutura com as informações de cheques devolvidos
"success": true,
"erro": "string",
"mensagem": "string", Mensagem de erro
"totalCheques": 0, total de cheques
"totalNomesRelacionados": 0, Quantidade de nomes relacionados
"ocorrencias": [
{
"nome": "string",
"dataUltimo": "2022-09-06T13:04:44.138Z", 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": 0 Quantidade
}
]
},
"chequesDevolvidosOutrosMotivos": { Estrutura com as informações de cheques
"success": true,
"erro": "string",
"mensagem": "string",
"totalCheques": 0, Total Cheques
"totalNomesRelacionados": 0,
"ocorrencias": [
{
"nome": "string",
"dataUltimo": "2022-09-06T13:04:44.138Z", 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": 0,
"periodoInicial": "2022-09-06T13:04:44.138Z",
"periodoFinal": "2022-09-06T13:04:44.138Z",
"ultimasOcorrencias": [
{
"data": "2022-09-06T13:04:44.138Z",
"banco": "string",
"agencia": "string",
"cheques": "string",
"dataOcorrencia": "2022-09-06T13:04:44.138Z"
}
]
},
"chequesDevolvidosInformadosUsuario": {
"success": true,
"mensagem": "string",
"quantidadeTotal": 0,
"periodoInicial": "2022-09-06T13:04:44.138Z",
"periodoFinal": "2022-09-06T13:04:44.138Z",
"ultimasOcorrencias": [
{
"informante": "string",
"banco": "string",
"agencia": "string",
"chequesInicial": "string",
"chequesFinal": "string",
"dataOcorrencia": "2022-09-06T13:04:44.138Z",
"dataRegistro": "2022-09-06T13:04:44.138Z",
"motivo": "string",
"cidade": "string",
"uf": "string"
}
]
}
},
"pendenciasRestricoes": { Estrutura de pendências e restrições
"mensagem": "string",
"totalPendencias": 0, Total de pendências
"totalCredores": 0, Total de Credores
"valor": 0, Valor das pendências
"periodoInicial": "2022-09-06T13:04:44.138Z",
"periodoFinal": "2022-09-06T13:04:44.138Z",
"valorPrimeiro": 0, Valor da primeira pendências
"dataPrimeiro": "2022-09-06T13:04:44.138Z",
"valorMaior": 0, Valor da maior pendências
"dataMaior": "2022-09-06T13:04:44.138Z",
"success": true,
"erro": "string",
"ocorrencias": [
{
"informante": "string", Informante
"tipo": "string", Tipo da ocorrência
"cidade": "string", Cidade
"uf": "string", UF
"documentoOrigem": "string", Documento origem
"dataDebito": "2022-09-06T13:04:44.138Z", Data débito
"disponivelEm": "2022-09-06T13:04:44.138Z",
"valor": 0, Valor da ocorrência
"tipoParticipante": "string", Tipo participante
"numeroContrato": "string" Número contrato
}
]
},
"acoesCiveis": { Estrutura de ações
"mensagem": "string",
"totalAcoes": 0, Total de ações
"valorTotal": 0, Valor total
"valorPrimeiro": 0, Valor do primeiro
"dataPrimeiro": "2022-09-06T13:04:44.138Z", Data do primeiro
"valorMaior": 0, Valor do maior
"dataMaior": "2022-09-06T13:04:44.138Z", Data do maior
"success": true,
"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": "2022-09-06T13:04:44.138Z",
"valor": 0, Valor da ação
"comarca": "string" Comarca
}
]
},
"falenciasRecuperacaoJudicial": { Estrutura de Falencia e Recuperação
"success": true,
"erro": "string",
"mensagem": "string",
"quantidadeTotal": 0, Quantidade total
"periodoInicial": "2022-09-06T13:04:44.138Z",
"periodoFinal": "2022-09-06T13:04:44.138Z",
"ultimasOcorrencias": [
{
"tipoOcorrencia": "string", Tipo de ocorrencia
"data": "2022-09-06T13:04:44.138Z",
"cidade": "string", Cidade
"uf": "string", UF
"vara": "string", Vara
"processo": "string" Número do processo
}
]
},
"quadroSocietarioV2": {
"success": true,
"message": "string",
"quadroSocietario": [
{
"participacao": "string",
"nome": "string",
"documento": "string",
"dataEntrada": "string",
"cargoSociedade": "string",
"cidade": "string",
"uf": "string",
"cep": "string",
"alerta": "false", Quando retornar true indica que encontramos alteração no quadro societário.
"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
}
]
}
}

# 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ônimo. 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/v2/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: 05284733000119
    89821221000134
    20255656000162
    33011896000163
    97984436000102
    98035952000145
    34327224000124
    85251117000109 (Smart)
    98035952000145 (Smart)
  • Documentos PF: 00888358121
    42166481779
    21347133054
    77115826501 (Smart)

# 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 endpointApiProducaoV2 = "https://api-portal.deps.com.br/api/v2/";

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

  • Contas a receber detalhado:

Endpoint POST: https://contas-receber.deps.com.br/api/v1/contas-receber/detalhado

Quando é realizada a chamada da consulta:

Endpoint POST: https://api-portal.deps.com.br/api/v2/consultas/depsmix

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.

Caso você não tenha verificado a documentação 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/v2/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.

← Manual do sistema →