Central de Ajuda/Catálogo de APIs/Crédito/Protestos Nacional - IEPTB Básica

Crédito

Protestos Nacional - IEPTB Básica

Disponível
Abrangência: Federal · PF/PJ · Fonte: Online
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).
Endpoint
https://apiv3.directd.com.br/api/ProtestosBasica?Cnpj={0}&Cpf={1}
Preço por consulta
R$ 2,95
Público-alvo
PF/PJ
Versão
v3

Parâmetros

NomeTipoObrig.Descrição
CNPJstringNão
O parâmetro CNPJ pode ser enviado com ou sem formatação.
CPFstringNão
O parâmetro CPF pode ser enviado com ou sem formatação.

Campos retornados

CampoDescrição
Data da ConsultaData da consulta
Valor ProtestadoValor total dos protestos que o indivíduo possui no cartório
ObservaçõesInforma as observações do registro.
Documento ConsultadoDocumento consultado referente ao CPF/CNPJ
Flag ProtestosInforma se a entidade consultada possui ou não protestos. True(verdadeiro) ou false(falso)
Lista de TítulosLista os títulos do indivíduo.
Valor Total dos ProtestosInforma o valor total dos protestos.
Número Total de ProtestosInforma a quantidade de protestos.
CNAE do DevedorInforma o CNAE do devedor.
Quantidade de Cartórios DistintosInforma a quantidade de cartórios distintos a entidade possui protestos.
Quantidade de Cidades DistintasInforma a quantidade e cidades distintas a entidade possui protestos.

Esta página foi útil?

curl -X GET \
  "https://apiv3.directd.com.br/api/ProtestosBasica?Cnpj=00000000000191&Cpf=12345678901&TOKEN=SEU_TOKEN"
Exemplo de resposta
200 OK
{
  "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",
    "dataConsulta": "string",
    "constamProtestos": true,
    "numeroTotalProtestos": 0,
    "valorTotalProtestos": "string",
    "cnaeDevedor": "string",
    "quantidadeCartoriosDistintos": 0,
    "quantidadeCidadesDistintas": 0,
    "observacoes": "string",
    "titulos": [
      {
        "valorProtestado": "string"
      }
    ]
  }
}
Falar com suporte