O que é#
Na consulta da certidão de antecedentes criminais da Polícia Federal você pode verificar a existência de decisões judiciais com trânsito em julgado.
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/pf-certidao-antecedentes-criminais
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 a ser pesquisado. |
| cpf | string | Sim | CPF da pessoa a ser pesquisada |
| nomeMae | string | Sim | Nome da Mãe da pessoa pesquisada |
| dataNascimento | string | Sim | Data de Nascimento da pessoa pesquisada. O formato da data de nascimento deve ser d/m/Y. Exemplo: 25/12/2000. |
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
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."
]
}
}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 decisões judiciais com os dados pesquisados |
| indefinido | Não foi possível emitir a Certidão de Antecedentes Criminais com base nos dados informados, o que não significa, necessariamente, a existência de registro. |
| erro | Inconsistência nos dados informados |
Resposta com status negativo
JSON
{
"status": "negativo",
"numeroCertidao": 1235,
"dataEmissao": "01/03/2023",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}Resposta com status indefinido
JSON
{
"status": "indefinido",
"numeroCertidao": 1234,
"dataEmissao": "01/03/2023",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}Resposta com status erro
JSON
{
"status": "erro",
"mensagem": "Inconsistência nos dados com o CPF informado.",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
