/api/DetalhamentoNegativo

💡 A API Detalhamento Negativo permite identificar pendências financeiras e jurídicas associadas a Pessoas Físicas ou Jurídicas, como protestos, ações judiciais, recuperações judiciais, falências e cheques sem fundo. Essencial para análise de risco e compliance.

Introdução

A API Detalhamento Negativo retorna informações detalhadas sobre pendências, como protestos em cartórios, ações judiciais, falências e cheques sem fundo. Ideal para análise de risco de crédito, onboarding de clientes e fornecedores e processos de compliance.


URL Base

A API está hospedada no seguinte endereço:

https://api.directd.com.br

Endpoint

GET /api/DetalhamentoNegativo

Descrição: Endpoint para realizar consultas sobre pendências financeiras e jurídicas de Pessoa Física ou Jurídica.

Nota: Esta consulta não oferece opção de gerar comprovantes.


Autenticação

Para acessar esta API, é necessário fornecer um token de autenticação.

Regras de Autenticação:

  1. O token deve ser enviado como parâmetro na URL da requisição.
  2. O token é obrigatório para realizar consultas.

Campos da API

Informações Gerais

  • Data da Consulta: Data em que a análise foi realizada.
  • Documento Consultado: CPF ou CNPJ associado à consulta.
  • Tipo de Pessoa: Pessoa Física ou Jurídica.

Pendências para Pessoa Física e Jurídica

Protestos

  • Cartórios: Dados dos cartórios onde os protestos foram registrados, incluindo nome, telefone e endereço.
  • Quantidade de Protestos: Número total de protestos.
  • Valor Protestado: Valor total dos protestos.

Ações Judiciais

  • Número do Processo: Identificação do processo judicial.
  • Parte Acusada: Nome da parte envolvida na ação.
  • Valor: Montante associado à ação judicial.
  • Tipo de Processo: Classificação do tipo de processo.
  • Comarca: Localidade onde a ação foi registrada.

Recuperações Judiciais e Falências

  • Documento: CPF ou CNPJ associado ao processo.
  • Nome da Empresa: Nome do estabelecimento envolvido.
  • Motivo: Justificativa para a recuperação ou falência.
  • Valor: Montante relacionado à recuperação judicial ou falência.
  • Endereço: Localização do estabelecimento.

Cheques Sem Fundo

  • Código do Banco: Código do banco onde o cheque foi registrado.
  • Nome da Agência: Nome da agência bancária.
  • Quantidade de Ocorrências: Número total de cheques sem fundo registrados.

Parâmetros

NomeTipoObrigatórioDescrição
CPFstringNãoCPF da pessoa a ser consultada. Pode ser enviado com ou sem formatação.
CNPJstringNãoCNPJ da empresa a ser consultada. Pode ser enviado com ou sem formatação.
TOKENstringSimToken de autenticação necessário para a consulta.

Exemplo de Requisição

Usando cURL

curl 'https://api.directd.com.br/api/DetalhamentoNegativo?CPF=12345678909&TOKEN=seu_token_aqui'

Respostas

Sucesso (200)

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Detalhamento Negativo",
    "consultaUid": "negativo-123456",
    "usuario": "Marcos",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 1500
  },
  "retorno": {
    "dataConsulta": "01/12/2024",
    "documentoConsultado": "123.456.789-09",
    "pessoaFisica": {
      "pendenciaFinanceira": {
        "status": "Ativo",
        "totalPendencia": 2,
        "protestos": [
          {
            "situacao": "Pendente",
            "valorTotal": 5000,
            "cartorios": [
              {
                "codigoCidade": "001",
                "codigoCartorio": "002",
                "nome": "Cartório Exemplo",
                "telefone": "(11) 99999-9999",
                "endereco": "Rua A, 123",
                "cidade": "São Paulo",
                "quantidadeProtestos": 1,
                "valorProtestado": 5000
              }
            ]
          }
        ],
        "acoesJudiciais": [
          {
            "numeroProcessoPrincipal": "0001234-56.2024.8.26.0000",
            "comarca": "São Paulo",
            "forum": "Fórum Central",
            "vara": "1ª Vara Cível",
            "parteAcusada": "João da Silva",
            "valor": 10000,
            "tipoProcesso": "Cobrança",
            "status": "Em Andamento",
            "autorProcesso": "Banco XYZ",
            "cidade": "São Paulo"
          }
        ],
        "chequesSemFundo": [
          {
            "tipoPessoa": "Física",
            "documento": "123.456.789-09",
            "codigoBanco": "123",
            "nomeAgencia": "Agência Central",
            "numeroAgencia": "001",
            "dataUltimaOcorrencia": "01/10/2024",
            "quantidadeOcorrencia": 1
          }
        ]
      }
    }
  }
}

Erros Comuns

CódigoDescrição
400Requisição Inválida: Parâmetros incorretos.
401Não Autenticado: Credenciais incorretas.
403Não Autorizado: Saldo insuficiente.
404Não Encontrado: Recurso solicitado não existe.
408Tempo Esgotado: O servidor não conseguiu processar a requisição no prazo estabelecido.
500Erro Interno: Falha ao processar a requisição. Entre em contato com o suporte.
503Consulta em Manutenção: O recurso solicitado está temporariamente indisponível.

Notas Importantes

  • Informe apenas um documento por requisição (CPF ou CNPJ).
  • Certifique-se de que o token de autenticação está ativo e válido.
  • Em caso de dúvidas ou suporte, entre em contato pelo e-mail suporte@directd.com.br.