post https://gateway.besinky.com/api/sandbox/public-api/consulta/6
Descrição
A **Consulta de Certidão de Antecedentes Criminais Polícia Federal **retorna informações sobre a emissão da certidão junto à Polícia Federal do Brasil.
O resultado pode indicar:
- “Nada Consta”, quando não existem registros de antecedentes;
- A Existência de antecedentes criminais, sem detalhamento dos mesmos.
Para consultar detalhes de processos criminais, recomenda-se utilizar a Consulta de Ações Judiciais, que possibilita identificar casos de condenação.
Esta consulta é distinta da Consulta de Antecedentes Criminais – Polícia Civil, que abrange registros em nível estadual.
Parâmetros de consulta
A tabela abaixo detalha os campos aceitos na consulta a este dataset.
Campo Descrição Valores Possíveis Tipo de Campo document Documento de identificação CPF Obrigatório type Identificador do tipo de consulta ADVANCED, ADDITIONAL_INPUTS Obrigatório subproducts Array de Slugs dos subprodutos que serão inclusos na busca ["certidao-antecedentes-criminais-policia-federal-pf"] Obrigatório
Quando o parâmetro type for definido como ADVANCED, a resposta incluirá os dados da Consulta Básica.
Quando definido como ADDITIONAL_INPUTS, a resposta conterá apenas os subprodutos e providers explicitamente informados na requisição.
Corpo da Resposta
| Campo | Tipo | Descrição | |
|---|---|---|---|
ticketId | string | Identificador da consulta | |
executadoEm | date | Data e hora da execução da consulta | |
status | string | 'Executado' | 'Executado com exceção'. Em caso de execução com exceção o campo exceptions será preenchido, porém a request retorna sucesso |
resultado | object | Resposta da Consulta Básica | |
exceptions | array<object> | Lista de exceções encontradas durante a execução da consulta. Preenchido apenas quando status = 'Executado com exceção' |
Estrutura de exceptions
exceptions| Campo | Tipo | Descrição |
|---|---|---|
message | string | Descrição do erro ocorrido. Exemplos: "Os slugs informados estão inativos.", "Os slugs informados não foram encontrados." |
slugs | array<string> | Lista dos slugs que ocasionaram a exceção |
Estrutura de resultado
resultado| Campo | Tipo | Descrição |
|---|---|---|
| certidao-antecedentes-criminais-policia-federal-pf | object | Lista com os detalhes do documento consultado |
Estrutura de certidao-antecedentes-criminais-policia-federal-pf
certidao-antecedentes-criminais-policia-federal-pf| Campo | Tipo | Descrição |
|---|---|---|
| name | string | Nome do subproduto consultado |
| status | integer | Status Code da Requisição |
| Result | object | Lista com os detalhes da consulta |
Estrutura de Result
Result| Campo | Tipo | Descrição |
|---|---|---|
| OnlineCertificates | array of objects | Lista de objetos contendo os dados das certidões emitidas online. |
| QueryId | string | ID único identificador da chamada. |
| ElapsedMilliseconds | number | Quantidade de milissegundos decorridos durante a chamada. |
| QueryDate | string | Data de quando o request foi recebido e processado |
Estrutura de OnlineCertificates
OnlineCertificates| Campo | Tipo | Descrição |
|---|---|---|
| Origin | string | Fonte dos dados entregues. |
| InputParameters | string | Parâmetros de entrada utilizados na consulta. |
| ProtocolNumber | string | Número de protocolo da certidão emitida. |
| BaseStatus | string | Status simplificado da certidão emitida. |
| AdditionalOutputData | object | Dados adicionais retornados pela certidão. |
| QueryDate | string | Data de realização da consulta. |