O que é

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

Sobre a requisição:

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/tjrs/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
tipo 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
endereco string Sim Endereço associado ao documento.
rg string Obrigatório caso o parâmetro cpfCnpj seja um CPF RG da pessoa em caso de busca por CPF
orgaoExpedidorRg string Obrigatório caso o parâmetro cpfCnpj seja um CPF Órgão expedidor do RG
ufRg string Obrigatório caso o parâmetro cpfCnpj seja um CPF UF do RG. Este campo é preenchido com a sigla do estado ou Distrito Federal ( df ).
nomeMae string Obrigatório caso o parâmetro cpfCnpj seja um CPF Nome da mãe da pessoa, em caso de busca por CPF
dataNascimento string Obrigatório caso o parâmetro cpfCnpj seja um CPF Data de nascimento da pessoa, em caso de busca por CPF

Valores possíveis para o campo "tipo"

Valor Descrição
2 Certidão Judicial Criminal Negativa
3 Certidão Judicial Cível Negativa de 1º Grau
6 Certidão Judicial Cível Negativa de 1º Grau - Insolvência civil
7 Certidão Judicial Cível Negativa de 1º Grau - Falência
9 Certidão Judicial Cível Negativa de 1º Grau - Execuções Fiscais

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 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"

Status Significado
negativo NÃO foram encontrados ações relacionados ao documento pesquisado
indefinido Não é possível informar se a pessoa ou empresa possui ações

Resposta com registro encontrado

JSON
{
  "status": "negativo",
  "codigoControle": "43f2137771a9fd81811b55fe624aa16d",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
JSON
{
  "status": "indefinido",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}