O que é#
Com a consulta TRF6 - Certidão judicial Eproc é possível identificar se uma pessoa ou empresa possui processos de natureza cível, criminal ou eleitoral no Tribunal
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/trf6/certidao-judicial
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 |
|---|---|---|---|
| tipoCertidao | string | Sim | Tipo da certidão. A tabela abaixo apresenta os valores possíveis. |
| cpfCnpj | string | Sim | CPF ou CNPJ a ser pesquisado. |
Valores possíveis para o campo "tipo"
| Valor | Descrição |
|---|---|
| criminal | Criminal |
| civel | Cível |
| eleitoral | Eleitoral |
Estrutura da resposta#
| 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 quando você faz a requisição#
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."
]
}
}Exemplos de retornos do resultado da pesquisa#
Valores possíveis do campo "status"
| Status | Significado |
|---|---|
| negativo | Empresa ou pessoa NÃO está associada a ações criminais na região TRF6 |
| erro | Erro ao buscar informações, seja por documento ou outro dado incorreto |
Respostas com registro encontrado
JSON
{
"status": "negativo",
"tipoCertidao": "Certidão judicial cível",
"nome": "FULANO DE TAL",
"documento": "000.000.000-00",
"codigo": "012342344jhgjh3423j",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}Resposta com erro
JSON
{
"status": "erro",
"mensagem": "Não foi possível emitir a certidão"
}
