Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

O que é

A consulta CENPROT - Central Nacional de Protesto informa se uma pessoa ou empresa tem relação com algum protesto dos cartórios participantes.

Veja mais informações em nossa central de ajuda: CENPROT - Central Nacional de Protesto

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/cenprot/consulta-protesto

...

Include Page
URL Base
URL Base

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

...

Code Block
{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

...

Code Block
{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo name é obrigatório."
    ]
  }
}

 

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )

Valores possíveis do campo “status“

...