Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Current »

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.

Veja mais informações em nossa central de ajuda: TRF4 - Certidão de Distribuição

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.

Quando o resultado é negativo em todos os estados, a API retornará o status “negativo“.

Quando o resultado em pelo menos um dos estados é não negativo (positivo ou indefinido), há 2 possibilidades de pesquisa, com senha e sem senha:

Pesquisa com senha

Você pode fazer uma pesquisa informando seu login e senha de acesso ao TRF4.

Quando você informa login e senha, em caso de resultado não negativo, o Plexi fará autenticação no portal do TRF4 usando seus dados e irá solicitar uma segunda verificação, para saber se o resultado é indefinido ou positivo.

O Plexi irá retornar os resultados quando as certidões dos 3 estados estiverem prontas.

O resultado poderá ser positivo ou indefinido, de acordo com o que é retornado por cada tribunal.

Pesquisa sem senha

Caso seu login e senha não sejam informados nos parâmetros da requisição, em caso de resultado não negativo, o Plexi retornará o status “indefinido“, indicando que não é possível dizer se as certidões são positivas.

O resultado poderá ser realmente indefinido ( casos de pessoas com nomes iguais ) ou positivo, quando há ação criminal.

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

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

string

Sim

Tipo da certidão. A tabela abaixo apresenta valores possíveis.

cpfCnpj

string

Sim

CPF ou CNPJ a ser pesquisado.

nome

string

Não

Nome associado ao documento informado

email

string

Não

Seu login de acesso ao TRF4

senha

string

Não

Sua senha de acesso ao TRF4

dataNascimento

string

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

Valores possíveis para o campo “tipo“

Valor

Descrição

civil

Certidão Judicial Cível

criminal

Certidão Judicial Criminal

eleitoral

Certidão Judicial para Fins Eleitorais

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.

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

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo name é 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 TRF4

positivo

Empresa ou pessoa está associada a ações criminais na região TRF4

erro

Erro ao buscar informações, seja por documento ou outro dado incorreto

indefinido

Não é possível definir se a certidão buscada é positiva

Resposta com registro encontrado

{
   "status": "positivo",
   "pdf": ["PDF em base 64", "PDF em base 64", "PDF em base 64"]
}

Resposta com erro

{
  "status": "erro",
  "mensagem": "E-mail ou senha incorreta."
}
  • No labels