DIdirectdigital
Antecedentes Criminais

Antecedentes Criminais

Changed on

Emissão ou validação de antecedentes criminais estaduais nas UFs atendidas.

post/br/antecedentes-criminais/{Uf}

Request

  • Base URL
    https://api.directdigital.com.br
  • URL
    https://api.directdigital.com.br/br/antecedentes-criminais/{Uf}
  • Auth
    API key in header token

Path parameters

ufstring required

UF atendida: AC, AL, BA, CE, ES, GO, MA, MG, MS, MT, PA, PE, PI, PR, RJ, RR, RS, SC, SP ou TO.

Query parameters

test_modeboolean

Modo Teste (retorna dados simulados)

lightweightboolean

Modo Lightweight (uso interno)

Request body application/x-www-form-urlencoded

cpfstring

CPF. Obrigatório em AC, AL, CE, GO, MA, MS, MT, PA, PE, PI, PR, RJ, RR, RS, SP e TO.

rgstring

RG. Obrigatório em AC, AL, BA, CE, ES, GO, MA, MS, MT, PA, PE, PI, PR, RR, RS e TO.

documentostring

Documento com 1 a 11 dígitos. Obrigatório em MG, nas etapas emitir e validar.

nomestring

Nome completo. Obrigatório em AC, AL, BA, CE, ES, GO, MA, MS, MT, PA, PE, PI, PR, RR, RS e TO.

nome_maestring

Nome da mãe. Obrigatório em AC, AL, CE, GO, MA, MS, MT, PA, PE, PI, PR, RR e TO.

nome_paistring

Nome do pai. Obrigatório em MT; opcional em ES, GO, MA, MS, PA, PE, PI, PR, RJ, RR, SP e TO.

data_nascimentostring date-time

Data de nascimento. Formato: AAAA-MM-DD. Obrigatória em AC, AL, BA, CE, ES, GO, MA, MS, MT, PA, PE, PI, PR, RR, RS e TO.

rg_uf_emissorstring

UF emissora do RG. Obrigatória em ES, GO, MS, MT, PA e PE.

rg_orgao_emissorstring

Órgão emissor do RG. Obrigatório em MS, MT, PE e TO; opcional em GO e PI.

emailstring

E-mail. Obrigatório em GO e PI; opcional em PR, RJ e TO.

sexostring

Sexo. Obrigatório em MS e RR; opcional em PE e SP.

naturalidadestring

Naturalidade. Obrigatória em PE e PI; opcional em SC.

naturalidade_ufstring

UF de naturalidade. Obrigatória em PA e PE; opcional em RJ, SC e TO.

naturalidade_cidadestring

Cidade de naturalidade. Obrigatória em PA; opcional em RJ e TO.

naturalidade_cidade_idstring

Identificador da cidade de naturalidade, opcional em PA.

estado_civilstring

Estado civil, opcional em PE e TO.

nacionalidadestring

Nacionalidade. Obrigatória no PI; opcional em PE.

protocolostring

Protocolo, usado nas etapas de consulta/validação em RJ, SC, MS, RR, PA e PE. Em PA são 11 dígitos e em PE são 16 dígitos impressos no atestado.

digitostring

Dígito do RG, opcional em BA.

rg_dvstring

Dígito verificador do RG, opcional em RR e SP.

rg_data_expedicaostring

Data de expedição do RG. Formato: AAAA-MM-DD. Opcional em SP.

tipo_emissaostring

Modo de emissão em SP: rg (padrão) ou cin (Carteira de Identidade Nacional). Usado somente na etapa emitir.

cin_data_expedicaostring

Data de expedição da CIN. Formato: AAAA-MM-DD. Obrigatória em SP quando tipo_emissao=cin.

codigostring

Em MT, Código de Segurança de 1 a 10 caracteres alfanuméricos, enviado em maiúsculas. Em MA, Código de validação impresso no atestado, com exatamente 12 caracteres alfanuméricos. Código do atestado, usado na etapa validar de BA, CE, GO, ES, RS, SP, MG e PR. Em CE é o Número do Atestado, de 1 a 13 dígitos. Em ES é o Verificador numérico; em RS são 12 dígitos. Em GO é o hash de validação de 32 caracteres hexadecimais, enviado em minúsculas. Em BA é o código hexadecimal 8-4-4-4-12 impresso no atestado. Em MG é o código de verificação impresso no atestado, enviado exatamente como impresso. Em PR é a chave impressa no rodapé do atestado.

numerostring

Número da Certidão de MT: quatro dígitos, ponto e sequência numérica, com no máximo 15 caracteres. Obrigatório na etapa validar.

data_emissaostring

Em MT, Data/Hora emissão impressa na certidão: DD/MM/AAAA HH:MM, obrigatória na etapa validar; data sem hora é recusada. Nas demais UFs, data de emissão do atestado. Formato: AAAA-MM-DD ou DD/MM/AAAA. Obrigatória na etapa validar de MA, MG, MS, PA, PE e RR. Em MA e RR use a data impressa no atestado: o relógio do portal pode diferir da data de emissão em Brasília.

hora_emissaostring

Hora de emissão do atestado: em PA e PE, HH:MM:SS, incluindo os segundos impressos; em MS e RR, HH:MM. Obrigatória na etapa validar de MS, PA, PE e RR. RR também aceita H:MM: use a hora impressa no atestado, sem converter para o horário de Brasília.

rg_orgaostring

Órgão emissor do RG, opcional em RJ.

rg_data_emissaostring

Data de emissão do RG. Formato: AAAA-MM-DD. Opcional em RJ.

data_expedicaostring

Data de expedição do RG. Formato: AAAA-MM-DD. Opcional em PE.

documento_imagemstring

Documento de identificação (JPEG, PNG ou PDF, até 4 MiB) em base64 ou data URI. Obrigatório no PI.

motivostring

Motivo da solicitação, opcional em RJ.

local_nascimentostring

Local de nascimento. Obrigatório em MT.

celularstring

Celular, opcional em PR.

telefonestring

Telefone, opcional em TO.

maestring

Nome da mãe no fluxo de validação de SC.

paistring

Nome do pai no fluxo de validação de SC.

nascimentostring

Data de nascimento. Formato: AAAA-MM-DD. Usada no fluxo de validação de SC.

rg_numerostring

Número do RG no fluxo de validação de SC.

rg_ufstring

UF do RG no fluxo de validação de SC.

senhastring

Senha do atestado no fluxo de validação de SC.

endereco_ufstring

UF do endereço. Obrigatória em MA, PE e PR; opcional em RJ e TO.

endereco_cidadestring

Cidade do endereço. Obrigatória em MA, PE e PR; opcional em RJ e TO.

endereco_bairrostring

Bairro. Obrigatório em MA e PE; opcional em RJ e TO.

endereco_logradourostring

Logradouro. Obrigatório em MA; opcional em RJ e TO.

endereco_ruastring

Rua. Obrigatória em PE; opcional em RJ e TO.

endereco_numerostring

Número do endereço. Obrigatório em MA e TO; opcional em PE e RJ.

endereco_cepstring

CEP. Obrigatório em TO; opcional em PE e RJ.

endereco_geralstring

Endereço em texto livre. Obrigatório em PR.

endereco_complementostring

Complemento do endereço, opcional em MA, PE, RJ e TO.

endereco_referenciastring

Referência do endereço, opcional em MA, PE, RJ e TO.

etapastring

Etapa do fluxo: MA (emitir/validar), BA (emitir/validar), CE (emitir/validar), PA (emitir/validar), PE (emitir/validar), GO (emitir/validar), MS (emitir/validar), RR (emitir/validar), ES (emitir/validar), RS (emitir/validar), MG (emitir/validar), PR (emitir/validar), RJ (solicitar/consultar), SC (validar/emitir) ou SP (emitir/validar).

emitirboolean

Autoriza o portal a registrar uma solicitação ou emitir um documento em nome da pessoa consultada. Sem essa autorização, fontes que só possuem fluxo de emissão são recusadas. O padrão é false.

profissaostring

Profissão. Opcional em PE.

endereco_telefonestring

Telefone do endereço. Opcional em PE.

endereco_ramalstring

Ramal do telefone. Opcional em PE.

Response

Success

ApiResultType'Success' | 'SuccessWithRemarks' | 'InvalidInput' | 'DataUnavailable' | 'NotFound' | 'InvalidParameters' | 'UnsupportedCombination' | 'RemoteUnavailable' | 'Timeout' | 'RetryLimitReached' | 'RemoteError' | 'InProgress' | 'InsufficientCredits' | 'ConcurrentLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'Created' | 'Updated' | 'Deleted' | 'InternalError' | 'ValidationFailed' | 'Conflict' | 'ResourceLocked' | 'PendingApproval' | 'Approved' | 'Rejected' | 'Cancelled' | 'Paused' | 'Resumed'

Novo tipo de resultado unificado para queries e operações administrativas. Substitui TransactionResultType com melhor semântica.

BalanceInBrlnumber double

Saldo atual em BRL.

BalanceInCreditsinteger

Saldo atual em créditos.

DataSourceCategorystring

Categoria da fonte de dados

Datestring date-time

Data da transação.

ElapsedTimeInMillisecondsinteger

Tempo de execução (em milisegundos).

ExecutedDataSourceNamestring

Nome de exibição do tipo de consulta que realmente executou.

ExecutedDataSourceTypeIdinteger

Id do tipo de consulta que realmente executou (o gravado na transação), que pode diferir do tipo pedido quando a rota é genérica por UF ou quando um master delega a uma sub-consulta.

HasOriginalFilesboolean

Indica que a transação carrega arquivos originais da fonte (a certidão emitida, por exemplo) para download em OriginalFilesUrl. Falso não significa que a URL não exista: ela é montada sempre.

HasPdfboolean

Indica que existe PDF de comprovante do resultado.

Messagestring

Mensagem.

OriginalFilesUrlstring

Url para download dos arquivos originais da transação (quando disponíveis).

OutdatedResultboolean

Indica que o resultado é datado.

PdfUrlstring

Url para download do arquivo de comprovante em PDF da transação (quando disponível).

ResultSubtypestring

Subtipo específico do resultado para fornecer contexto adicional (ex: 'duplicate_name', 'invalid_cpf').

ResultTypeCodeinteger

Código numérico do resultado (compatível com TransactionResultTypeCode mas extensível).

TotalCostnumber double

Internal use only.

TotalCostInCreditsinteger

Custo total da transação em créditos.

TransactionResultType'Success' | 'SuccessWithRemarks' | 'InvalidInputData' | 'UnavailableData' | 'EntityNotFound' | 'InvalidParameters' | 'ParametersNotSupported' | 'RemoteSystemUnavailable' | 'Timeout' | 'AttemptsLimitReached' | 'RemoteSystemError' | 'AsyncExecutionInProgress' | 'AwaitingExecution' | 'BirthDateRequired' | 'InsufficientBalance' | 'SimultaneousTransactionsLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'InternalError'
<table class="transaction"><thead><tr><th>TransactionResultType Code</th><th>TransactionResultType</th><th>Definitivo</th><th>Faturavel</th><th>Erro</th></tr></thead><tbody><tr><td>1</td><td>Sucesso</td><td>Verdadeiro</td><td>Verdadeiro</td><td>Falso</td></tr><tr><td>2</td><td>Sucesso parcial ou com observações</td><td>Verdadeiro</td><td>Verdadeiro</td><td>Falso</td></tr><tr><td>3</td><td>Entrada ou documento inválido</td><td>Verdadeiro</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>4</td><td>Dados não disponíveis</td><td>Verdadeiro (no dia)</td><td>Falso</td><td>Falso</td></tr><tr><td>5</td><td>Entidade ou documento inexistente/não encontrado</td><td>Verdadeiro</td><td>Verdadeiro</td><td>Falso</td></tr><tr><td>6</td><td>Parâmetros de entrada inválidos</td><td>Verdadeiro</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>7</td><td>Combinação de parâmetros não suportados</td><td>Verdadeiro</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>8</td><td>Fonte de dados ou sistema remoto indisponível</td><td>Falso</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>9</td><td>Limite de tempo esgotado</td><td>Falso</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>10</td><td>Limite de tentativas atingido</td><td>Falso</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>11</td><td>Erro na fonte de dados ou sistema remoto</td><td>Falso</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>12</td><td>Transação em execução</td><td>Falso</td><td>Falso</td><td>Falso</td></tr><tr><td>101</td><td>Saldo em créditos insuficiente, entre em contato</td><td>Falso</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>102</td><td>Limite de transações simultâneas atingido, entre em contato</td><td>Falso</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>103</td><td>Transação não disponível, entre em contato</td><td>Falso</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>104</td><td>Credenciais inválidas ou acesso negado, entre em contato</td><td>Falso</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>105</td><td>Transação cancelada, entre em contato</td><td>Falso</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>255*</td><td>Erro interno não esperado, entre em contato</td><td>Verdadeiro (no dia)</td><td>Falso</td><td>Verdadeiro</td></tr><tr><td>* Consulta em manutenção, tente refazer mais tarde ou entre em contato com a Exato para notificação do problema</td></tr></tbody></table>
TransactionResultTypeCodeinteger

Código do tipo de resultado da transação.

UniqueIdentifierstring

Identificador único da transação. Recomendado armazenar para controle e depuração.

Changes