O que é
A certidão de distribuição TRF4 atesta que uma pessoa ou empresa possui ou não alguma ação de natureza criminal.
A certidão TRF4 informa sobre ações ocorridas nos estados Paraná, Santa Catarina e Rio Grande do Sul.
Funcionamento desta API:
Quando você faz uma requisição a esta API, são buscadas informações sobre ações criminais referentes aos 3 estados da região sul: Paraná, Santa Catarina e Rio Grande do Sul.
...
Info |
---|
IMPORTANTE: as informações de login e senha são utilizadas pelo Plexi no momento da consulta apenas. Logo após a utilização são descartadas. |
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/trf4/certidao-regional
...
Include Page | ||||
---|---|---|---|---|
|
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
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 | string | Sim | Tipo da certidão. A tabela abaixo apresenta valores possíveis. |
cpfCnpj | string | Sim | CPF ou CNPJ a ser pesquisado. Deve ser informado sem pontuação. Exemplo: 99999999999 |
nome | string | Sim | Nome associado ao documento informado |
login | string | Não | Seu login de acesso ao TRF4 |
senha | string | Não | Sua senha de acesso ao TRF4 |
dataNascimento | atring | Não | Data de nascimento da pessoa, em caso de busca por CPF |
rg | string | Não | RG da pessoa em caso de busca por CPF |
orgaoExpedidor | string | Não | Órgão expedidor do RG, em caso de busca por CPF |
nomeMae | string | Não | Nome da mãe da pessoa, em caso de busca por CPF |
...
Valor | Descrição |
---|---|
c | Tipo 1.Fins Gerais 1º Grau - Criminal |
n | Tipo 1.Fins Gerais 1º Grau - Cível |
a | Tipo 1.Fins Gerais 1º Grau - Cível e Criminal |
jc | Tipo 2.Fins Gerais 2ºGrau (TRF) - Criminal |
jn | Tipo 2.Fins Gerais 2ºGrau (TRF) - Cível |
ja | Tipo 2.Fins Gerais 2ºGrau (TRF) - Cível e Criminal |
f | Tipo 3.Fins Eleitorais (Lei da Ficha Limpa) - Eleitoral 1º Grau |
t | Tipo 3.Fins Eleitorais (Lei da Ficha Limpa) - Eleitoral 2º Grau (TRF) |
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
Include Page | ||||
---|---|---|---|---|
|
...
Include Page | ||||
---|---|---|---|---|
|
Exemplos de retornos do resultado da pesquisa
Resposta com registro encontrado
...
Code Block | ||
---|---|---|
| ||
{ "status": "erro", "mensagem": "RenavamE-mail nãoou pertence a esta placa" } | ||
Code Block | ||
| ||
{ "status": "erro", "mensagem": "Nenhum registro encontrado no Detran para a Placa/Renavamsenha incorreta." } |