DIdirectdigital
Antecedentes Criminais

Antecedentes Criminais - SP

Changed on

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

post/br/antecedentes-criminais/sp

Request

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

Query parameters

test_modeboolean

Modo Teste (retorna dados simulados)

lightweightboolean

Modo Lightweight (uso interno)

Request body application/x-www-form-urlencoded

cpfstring

CPF do titular. Obrigatório na etapa emitir, e é o número da CIN quando tipo_emissao=cin; opcional na etapa validar, onde o portal confere apenas o código e nunca vê o CPF.

nomestring

Nome completo do titular. Obrigatório na etapa emitir.

nome_paistring

Nome do pai. Obrigatório na etapa emitir.

sexostring

Sexo do titular (M ou F). Obrigatório na etapa emitir.

rgstring

Número-base do RG-SP, com 1 a 8 dígitos. Obrigatório na etapa emitir pelo RG.

rg_dvstring

Dígito verificador SSP-SP do RG (um dígito ou X). Obrigatório na etapa emitir pelo RG.

rg_data_expedicaostring

Data de expedição do RG. Formato: AAAA-MM-DD. Obrigatória na etapa emitir pelo RG.

tipo_emissaostring

Documento usado na emissão: rg (padrão) ou cin (Carteira de Identidade Nacional emitida por SP). Usado somente na etapa emitir.

cin_data_expedicaostring

Data de expedição da CIN. Formato: AAAA-MM-DD. Obrigatória na etapa emitir pela CIN.

codigostring

Código UUID do atestado no formato 8-4-4-4-12. Obrigatório na etapa validar.

etapastring

Etapa do fluxo. Valores permitidos: emitir ou validar.

nome_maestring

Nome da mãe exatamente como impresso no documento. Obrigatório na etapa emitir.

data_nascimentostring date-time

Data de nascimento. Formato: AAAA-MM-DD. Obrigatória na etapa emitir.

rg_orgao_emissorstring

Órgão emissor do RG. Aceito e ignorado: em SP o emissor é sempre a SSP-SP.

emitirboolean

Autoriza o portal a registrar ou emitir o documento em nome do titular. As UFs sem consulta somente-leitura recusam a requisição sem ele.

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