Orientações e respostas da equipe da Direct Data

💡A API Protestos - Nacional permite verificar a existência de protestos registrados no Instituto de Estudos de Protesto de Títulos do Brasil (IEPTB). A consulta fornece detalhes sobre os protestos, incluindo número, valor e dados dos cartórios responsáveis.

Introdução

A API Protestos - Nacional possibilita consultar dados detalhados sobre protestos de pessoas físicas ou jurídicas, úteis para análises de crédito e verificações cadastrais.

---

URL Base

A API está hospedada no seguinte endereço:

https://api.directd.com.br

---

Endpoint

Consulta de Protestos

GET /api/Protestos

Descrição: Endpoint para consulta de protestos registrados no IEPTB.

Nota: Esta consulta pode gerar comprovantes em PDF, caso habilitado.

---

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

Dados Gerais

• Documento Consultado: CPF ou CNPJ consultado.
• Data da Consulta: Data em que a consulta foi realizada.
• Flag Protestos: Indica se há protestos registrados.
• Número Total de Protestos: Total de protestos associados ao documento consultado.
• Número Total de Protestos no Estado: Total de protestos registrados no estado consultado.

Protestos

• Estado: Unidade Federativa onde o protesto foi registrado.
• Pesquisa Efetuada Em: Data de realização da pesquisa.
• Pesquisa Retroativa Até: Data limite da pesquisa retroativa.

Detalhes do Cartório

• Nome: Nome do cartório responsável pelo protesto.
• Cidade: Cidade onde o cartório está localizado.
• Endereço: Endereço do cartório.
• Telefone: Telefone de contato do cartório.
• Código do Cartório: Código identificador do cartório.
• Código da Cidade: Código identificador da cidade.
• Data de Atualização: Data da última atualização do registro no cartório.
• Número de Protestos: Número de protestos registrados no cartório.

Detalhes do Protesto

• Data do Protesto: Data em que o protesto foi registrado.
• Valor Protestado: Valor associado ao protesto.

---

Parâmetros

---

Exemplos de Requisição

Usando cURL

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

---

Respostas

Sucesso (200)

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Protestos - Nacional",
    "consultaUid": "protestos-123456",
    "usuario": "João Silva",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 200
  },
  "retorno": {
    "constamProtestos": true,
    "documentoConsultado": "123.456.789-09",
    "dataConsulta": "2024-12-09",
    "protestos": [
      {
        "estado": "SP",
        "pesquisaEfetuadaEm": "2024-12-08",
        "pesquisaRetroativaAte": "2024-01-01",
        "cartoriosProtesto": [
          {
            "cidade": "São Paulo",
            "nome": "Cartório Central",
            "endereco": "Rua Central, 123",
            "observacao": "Registro atualizado",
            "telefone": "(11) 98765-4321",
            "codigoCartorio": "12345",
            "codigoCidade": "3550308",
            "dataAtualizacao": "2024-12-07",
            "numProtestos": 2,
            "protesto": [
              {
                "dataProtesto": "2024-11-01",
                "valorProtestado": "5000.00"
              },
              {
                "dataProtesto": "2024-10-15",
                "valorProtestado": "3000.00"
              }
            ]
          }
        ],
        "totalNumProtestosUf": 10
      }
    ],
    "totalNumProtestos": 10,
    "observacoes": "Consulta realizada com sucesso."
  }
}

---

Erros Comuns

---

Notas Importantes

• Apenas um CPF ou CNPJ pode ser informado por requisição.
• O comprovante em PDF é opcional e gera um custo adicional.
• Certifique-se de que seu saldo na plataforma seja suficiente para a consulta.