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.
Protestos Nacional - Base
Consulta a existência e os dados de Protestos de pessoas físicas e jurídicas no Instituto de Estudos de Protesto de Títulos do Brasil (IEPTB).
Casos de Uso
- Checagem de protestos em análise de crédito
- Qualificação de fornecedores e parceiros
- Políticas de cobrança segmentadas
- Prevenção à fraude com histórico de protestos
Aplicações
- Onboarding de Clientes e Fornecedores
- Análise de Risco/Crédito
Benefícios
- Cobertura nacional consolidada
- Melhor decisão com histórico de títulos protestados
- Reduz risco de inadimplência
- Dados normalizados para fácil consumo
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/ProtestosEndpoint
GET https://apiv3.directd.com.br/api/Protestos?Cnpj={0}&Cpf={1}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Protestos Nacional - Base.
Nota: Esta consulta gera comprovantes em PDF.
Esta API suporta geração de comprovantes em PDF
Campos Retornados
- Cidade: Cidade do registro em questão
- Código da Cidade: Código de identificação da cidade
- Código do Cartório: Código de identificação do cartório
- Data da Consulta: Data da consulta
- Data de Atualização: Data de atualização do registro
- Data do Protesto: Data de abertura do protesto
- Documento Consultado: Documento consultado referente ao CPF/CNPJ
- Endereço: Informa o endereço do indivíduo
- Estado: Nome do estado
- Flag Protestos: Informa se a entidade consultada possui ou não protestos. True(verdadeiro) ou false(falso)
- Lista de Cartório do Protesto: Informações do cartório ao qual está referido o protesto
- Lista de Protesto: Retorna a lista de protesto que o indivíduo possui
- Lista de Protestos: Retorna a lista de protestos que o indivíduo possui
- Nome: Nome do indivíduo/registro
- Número de Protestos: Número de protestos no cartório
- Número Total de Protestos: Número total de protestos do cartório
- Número Total de Protestos no Estado: Número total de protestos do cartório no estado
- Observação: Observação relacionada ao registro retornado
- Observações: Informa as observações do registro.
- Pesquisa Efetuada Em: Data que a pesquisa de protesto foi realizada
- Pesquisa Retroativa Até:
- Telefone: Número de telefone do indivíduo ou entidade
- Valor Protestado: Valor total dos protestos que o indivíduo possui no cartório
- Valor Total dos Protestos: Informa o valor total dos protestos.
- Valor Total dos Protestos no Cartório: Informa o valor total dos protestos no cartório.
- Valor Total dos Protestos no Estado: Informa o valor total dos protestos no estado.
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
CPF | string | Sim | O parâmetro CPF pode ser enviado com ou sem formatação. |
CNPJ | string | Sim | O parâmetro CNPJ pode ser enviado com ou sem formatação. |
TOKEN | string | Sim | O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br |
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"enviarCallback": false,
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"constamProtestos": true,
"documentoConsultado": "string",
"dataConsulta": "string",
"protestos": [
{
"estado": "string",
"pesquisaEfetuadaEm": "string",
"pesquisaRetroativaAte": "string",
"cartoriosProtesto": [
{
"cidade": "string",
"nome": "string",
"endereco": "string",
"observacao": "string",
"telefone": "string",
"codigoCartorio": "string",
"codigoCidade": "string",
"dataAtualizacao": "string",
"numProtestos": 0,
"possuiAnuencia": true,
"protesto": [
{
"dataProtesto": "string",
"valorProtestado": "string"
}
],
"valorTotalProtestosCartorio": "string"
}
],
"totalNumProtestosUf": 0,
"valorTotalProtestosEstado": "string"
}
],
"totalNumProtestos": 0,
"valorTotalProtestos": "string",
"observacoes": "string"
}
}Erros Comuns
| Código | Descrição |
|---|---|
400 | Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos. |
401 | Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso. |
403 | Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível. |
404 | Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado. |
408 | Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido. |
500 | Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte. |
503 | Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte. |
Notas Importantes
- Informe apenas um único documento por requisição
- Para obter o comprovante desta consulta, utiliza-se: '&GerarComprovante=habilitar' na URL
- Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
- Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228