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).
Artigo do Blog
Protestos Nacional - IEPTB Online
Casos de Uso
- Onboarding de clientes e fornecedores com verificação de histórico de protestos.
- Análise de risco e crédito com base em ocorrências de protesto.
- Identificação de protestos de pessoas físicas e jurídicas em âmbito nacional.
- Apoio a processos de due diligence, compliance e prevenção a fraudes.
- Suporte para decisões de crédito com dados atualizados do IEPTB.
Aplicações
- Onboarding de Clientes e Fornecedores
- Análise de Risco/Crédito
Benefícios
- Acesso automatizado e atualizado a informações de protestos em todo o Brasil.
- Reduz erros manuais e tempo de análise em processos de crédito e onboarding.
- Facilita a visualização consolidada de protestos por estado e cartório.
- Integração simples e escalável com sistemas internos de risco e compliance.
O endpoint /api/ProtestosNacionalIEPTB permite consultar a existência e os dados de protestos de pessoas físicas e jurídicas junto ao Instituto de Estudos de Protesto de Títulos do Brasil (IEPTB). Esta documentação detalha como autenticar, enviar requisições, interpretar respostas e tratar erros durante a integração.
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/ProtestosOnlineEndpoint
GET https://apiv3.directd.com.br/api/ProtestosOnline?Cnpj={0}&Cpf={1}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Protestos Nacional - IEPTB Online.
Nota: Esta consulta não gera comprovantes.
Campos Retornados
- Cidade: Cidade do registro em questão
- Código da Cidade: Código de identificação da cidade
- Data do Protesto: Data de abertura do protesto
- Documento Consultado: Documento consultado referente ao CPF/CNPJ
- Estado: Nome do estado
- Flag Protestos: Informa se a entidade consultada possui ou não protestos. True(verdadeiro) ou false(falso)
- Lista de Cartórios: Lista de cartórios que o indivíduo possui protestos
- Lista de Protestos: Retorna a lista de protestos que o indivíduo possui
- Lista de Títulos: Lista os títulos do indivíduo.
- Número de Protestos: Informa o número de protestos.
- Número Total de Protestos: Informa a quantidade de protestos.
- Número Total de Protestos na UF: Informa a quantidade de protestos na UF.
- Observações: Informa as observações do registro.
- 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": {
"documentoConsultado": "string",
"constamProtestos": true,
"numeroTotalProtestos": 0,
"valorTotalProtestos": "string",
"observacoes": "string",
"protestos": [
{
"estado": "string",
"numeroTotalProtestosUF": 0,
"valorTotalProtestosEstado": "string",
"cartorios": [
{
"codigoCidade": "string",
"cidade": "string",
"numeroProtestos": 0,
"valorTotalProtestosCartorio": "string",
"titulos": [
{
"dataProtesto": "string",
"valorProtestado": "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 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