O que é#
Com a certidão de antecedentes cíveis do TJPA é possível verificar se uma pessoa possui ações cíveis no TJPA.
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/tjpa/certidao-antecedentes-civeis
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 |
|---|---|---|---|
| nome | string | Sim | Nome do requerente |
| cpf | string | Sim | CPF do requerente, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99 |
| endereco | string | Sim | Endereço do requerente |
| nomeMae | string | Sim | Nome da mãe do requerente |
| estadoCivil | string | Sim | Estado civil do requerente |
| naturalidade | string | Sim | Naturalidade do requerente (ex: CE, SP…) |
Valores possíveis para o campo "estadoCivil"
| Valor | Descrição |
|---|---|
| solteiro | Solteiro(a) |
| casado | Casado(a) |
| viuvo | Viuvo(a) |
| uniaoEstavel | União estável |
| divorciado | Divorciado(a) |
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 encontradas ações relacionados ao CPF pesquisado |
| indefinido | O sistema encontrou informações que impossibilitaram emissão de uma certidão negativa online |
Resposta com registro encontrado
JSON
{
"status": "negativo",
"nome": "FULANO DE TAL",
"nomeMae": "FULANA DE TAL",
"cpf": "999.999.999-99",
"estadoCivil": "Solteiro(a)",
"endereco": "Rua Exemplo, 123",
"naturalidade": "Ceará",
"nacionalidade": "BRASILEIRA",
"dataEmissao": "01/01/2020 14:59:37",
"controle": "0000",
"numero": "00000000",
"validaAte": "01/01/2020",
"pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}Resposta com status indefinido
JSON
{
"status": "indefinido",
"mensagem": "Erro na emissão da Certidão solicitada",
"pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7/..."
}
