ATENÇÃO: essa consulta retorna protestos apenas de São Paulo
O que é#
A consulta CENPROT SP - Central de Protesto do Estado de São Paulo informa se uma pessoa ou empresa tem relação com algum protesto nos cartórios de São Paulo.
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/cenprot-sp/consulta-protesto
URL Base: https://api.plexi.com.br/
Parâmetros do header#
| Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
| Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com Bearer |
| Callback | String | Não | URL para onde o resultado da requisição será enviado via HTTP POST. |
Parâmetros do body#
| Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
| cpfCnpj | String | Sim | CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99 |
Retornos possíveis da requisição#
| Status | Significado | Descrição | Informações retornadas |
|---|---|---|---|
| 201 | Created | Solicitação criada | Campo requestId, com o ID da requisição criada. |
| 422 | Unprocessable Entity | A solicitação contém erro | Em quais campos houve erro. |
Exemplos de retornos#
Status 201#
A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.
JSON
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}Status 422#
Significa que ocorreu um erro de validação dos dados enviados.
JSON
{
"message": "The given data was invalid.",
"errors": {
"cpf": [
"O campo cpf é obrigatório."
],
"nome": [
"O campo nome é obrigatório."
]
}
}Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )#
Valores possíveis do campo "status"#
| Status | Significado |
|---|---|
| negativo | Pessoa ou empresa NÃO está associada a protestos nos cartórios de são paulo. |
| positivo | Pessoa ou empresa está associada a protestos nos cartórios de são paulo. |
Resposta com registro encontrado#
JSON
{
"status": "negativo",
"protocolo": "9999999999",
"cpfCnpj": "99.999.999/9999-99",
"quantidadeProtestos": 0,
"valorProtestado": 0,
"protestos": [],
"pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7..."
}JSON
{
"status": "positivo",
"protocolo": "9999999999",
"cpfCnpj": "99.999.999/9999-99",
"quantidadeProtestos": 9,
"valorProtestado": 49610.31,
"protestos": [
{
"comarca": "CIDADE EXEMPLO",
"cartorio": "1. TABELIAO DE PROTESTO DE LETRAS E TITULOS DA CIDADE EXEMPLO",
"quantidadeProtestos": 4,
"valorProtestado": 38580.6,
"endereco": "RUA EXEMPLO, 123, BAIRRO EXEMPLO, CIDADE EXEMPLO - SP",
"telefone": "(11) 99999-9999"
},
{
"comarca": "CIDADE EXEMPLO",
"cartorio": "2. TABELIAO DE PROTESTO DE LETRAS E TITULOS DA CIDADE EXEMPLO",
"quantidadeProtestos": 3,
"valorProtestado": 6537.43,
"endereco": "AVENIDA EXEMPLO, 456, BAIRRO EXEMPLO, CIDADE EXEMPLO - SP",
"telefone": "(11) 99999-9999"
},
{
"comarca": "CIDADE EXEMPLO",
"cartorio": "3. TABELIAO DE PROTESTO DE LETRAS E TITULOS DA CIDADE EXEMPLO",
"quantidadeProtestos": 2,
"valorProtestado": 4492.28,
"endereco": "RUA EXEMPLO, 789, BAIRRO EXEMPLO, CIDADE EXEMPLO - SP",
"telefone": "(11) 99999-9999"
}
],
"pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7..."
}
