O que é#

Com a certidão negativa do TJES você pode verificar se a pessoa ou empresa tem ação em tramitação.

Sobre a requisição#

Método: POST

Endereço: URL Base + /api/maestro/tjes/certidao-negativa

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
instancia integer Sim Instância do TJES a ser consultada
naturezaCertidao integer Sim Tipo de certidão. A tabela abaixo apresenta os valores possíveis.
cpfCnpj string Sim CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99
nome string Sim Nome associado ao documento informado

Valores possíveis para o campo "instancia"

Valor Descrição
1 Primeira Instância
2 Segunda Instância

Valores possíveis para o campo "naturezaCertidao"

Valor Descrição
1 Cível
3 Família
5 Criminal
6 Auditoria Militar
11 Recuperação Judicial e Extrajudicial (Falência e Concordata)
98 Execição Fiscal

observação: Em Segunda Instância somente as naturezas de Certidão Cível e Criminal são válidas.

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

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

Status 422

JSON
{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpfCnpj é 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 NÃO foram encontrados ações relacionados ao cpf/Cnpj pesquisado
indefinido O sistema encontrou informações que impossibilitaram emissão de uma certidão negativa online

Resposta com registro encontrado

JSON
{
    "status": "negativo", // negativo|positivo
    "codigoControle": "99999999",
    "dataExpedicao": "01\/01\/2020 13:36", // data da realização consulta.
    "naturezaCertidao": "CIVEL",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..." //base64 do pdf da consulta.
}
JSON
{
    "status": "indefinido",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}