A tabela abaixo detalha os campos aceitos na consulta a este dataset.
Campo
Descrição
Valores Possíveis
Tipo de Campo
document
Documento de identificação
CPF
Obrigatório
type
Identificador do tipo de consulta
ADVANCED, ADDITIONAL_INPUTS
Obrigatório
subproducts
Array de Slugs dos subprodutos que serão inclusos na busca
["protesto-pf"]
Obrigatório
Quando o parâmetro type for definido como ADVANCED, a resposta incluirá os dados da Consulta Básica.
Quando definido como ADDITIONAL_INPUTS, a resposta conterá apenas os subprodutos e providers explicitamente informados na requisição.
Corpo da Resposta
Campo
Tipo
Descrição
ticketId
string
Identificador da consulta
executadoEm
date
Data e hora da execução da consulta
status
string
'Executado'
'Executado com exceção'. Em caso de execução com exceção o campo exceptions será preenchido, porém a request retorna sucesso
resultado
object
Resposta da Consulta Básica
exceptions
array<object>
Lista de exceções encontradas durante a execução da consulta. Preenchido apenas quando status = 'Executado com exceção'
Estrutura de exceptions
Campo
Tipo
Descrição
message
string
Descrição do erro ocorrido. Exemplos: "Os slugs informados estão inativos.", "Os slugs informados não foram encontrados."
slugs
array<string>
Lista dos slugs que ocasionaram a exceção
Estrutura de resultado
Campo
Tipo
Descrição
protesto-pf
object
Lista com os detalhes do documento consultado
Estrutura de protesto-pf
Campo
Tipo
Descrição
name
string
Nome do subproduto consultado
status
integer
Status Code da Requisição
cpf
string
Documento CPF
cenprotProtestos
object
Protestos CENPROT
Estrutura de cenprotProtestos
Campo
Tipo
Descrição
[UF]
array (SP, RJ...)
Protestos do estado
Estrutura de [UF]
Campo
Tipo
Descrição
cartorio
string
Nome do cartório
obterDetalhes
sting
Código para consulta no CENPROT
cidade
string
Cidade
quantidadeTitulos
string
Quantidade de Títulos
endereco
string
Endereço
telefone
string
Telefone
protestos
Array (Exceto SP)
Protestos do estado
Estrutura de protestos
Campo
Tipo
Descrição
cpfCnpj
string
Documento
data
sting
Data
dataProtesto
string
Data do Protesto
dataVencimento
string
Data de Vencimento
valor
string
Valor
Language
Credentials
Header
Click Try It! to start a request and see the response here!
