DIdirectdigital
Exato - Consultas

Exato - Validação de Identidade

Exato - Validação de Identidade

post/br/exato/identity-validation

Request

  • Base URL
    https://api.directdigital.com.br
  • URL
    https://api.directdigital.com.br/br/exato/identity-validation
  • 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

Person's CPF (Brazilian Tax ID) / CPF a ser consultado

full_namestring

Person's full name (first name + surnames) / Nome completo da pessoa a ser consultada

date_of_birthstring date-time

Person's date of birth (e.g. dd/MM/yyyy) / Data de nascimento da pessoa a ser consultada (ex: dd/MM/aaaa)

sex'M' | 'F'

Person's biological sex ('M'=Male, 'F'=Female) / Sexo da pessoa consultada

nationalityinteger

Nacionalidade da pessoa consultada

mother_full_namestring

Mother's full name (first name + surnames) / Nome da mãe da pessoa a ser consultada

father_full_namestring

Father's full name (first name + surnames) / Nome do pai da pessoa a ser consultada

emailstring

Person's e-mail / Email a ser consultado

phone_numberstring

Person's phone, mobile or landline (country code + area code + number) / Telefone com DDD a ser consultado

credit_card_numberstring

Credit card numbers (DON'T USE THIS UNLESS INSTRUCTED BY EXATO) / Números do cartão de crédito a ser consultado

credit_card_number_last_4_digitsstring

Credit card last four digits / Últimos 4 números do cartão de crédito a ser consultado

credit_card_number_first_six_digitsstring

Credit card first six digits / Primeiros 6 números do cartão de crédito a ser consultado

user_remote_ip_addressstring

Person's IP address (end user/client, don't pass a server/proxy IP) / Endereço IP a ser consultado

ideal_timeoutstring

Ideal timeout for the call, on which certain decisions about 'liveness' of data sources will be made / Limite de espera ideal para a consulta

outdated_cpf_info_mode'Undefined' | 'FallbackOnly' | 'Never' | 'Always'

Potentially outdated CPF information utilization mode / Modo de utilização de informações de CPF potencialmente desatualizadas</br>We strongly recommend using the default mode, except in very specific use cases / Recomendamos usar o modo padrão, exceto em casos de uso muito específicos</br>* undefined: The default behavior will be used, decided by Exato (currently = fallback_only) / O comportamento padrão será utilizado, a critério da Exato (atualmente = fallback_only)</br>* fallback_only [default]: Allows the usage of outdated info in case the live/online sources are unavailable (related to parameter outdated_cpf_info_max_age) / Podem ser utilizadas informações desatualizadas caso as fontes online estejam indisponíveis (relacionado com o parâmetro outdated_cpf_info_max_age)</br>* never: Never use outdated information, causing an error if online sources are unavailable / Nunca utiliza informações desatualizadas, causando erro caso as fontes online estejam indisponíveis</br>* always: Always try to use local and potentially outdated information first, for better performance and response time (related to parameter outdated_cpf_info_max_age) / Sempre tenta primeiro usar informações locais e potencialmente desatualizadas, para melhor desempenho e tempo de resposta (relacionado ao parâmetro desatualizado_cpf_info_max_age)

outdated_cpf_info_max_agestring

Max age for outdaded CPF information (see also outdated_cpf_info_mode) / Limite de tempo de informações de CPF desatualizadas (veja também outdated_cpf_info_mode)

validate_against_government_databaseboolean

Validate info against official government database. This is not needed in most cases (check additional costs with Exato before using) / Validar com o banco de dados do governo. Isso não é necessário na maioria dos casos (verificar custos adicionais com a Exato antes de usar)

validate_emailboolean

Validate the person's email and try to detect temporary inboxes, invalid domains, debounce and others (not guaranteed) / Validar o email do usuário para tentar detectar caixas temporárias, domínios inválidos, debounce e outros (not guaranteed)

fetch_inquiry_historyboolean

Fetch inquiry history for the CPF / Retornar histórico de consultas do CPF

fetch_political_exposed_personboolean

Fetch Politically Exposed Person lists results for the CPF (Brazilian lists only) / Buscar CPF em listas de PEP/PPE - Pessoa exposta politicamente

fetch_ofac_sanctionsboolean

Fetch OFAC sanctions results for the person (matched by name, potential false positives) / Buscar sanções da OFAC para a pessoa (busca por nome, potenciais falsos positivos)

fetch_un_sanctionsboolean

Fetch UN sanctions results for the person (matched by name, potential false positives) / Buscar sanções da ONU para a pessoa (busca por nome, potenciais falsos positivos)

fetch_eu_financial_sanctionsboolean

Fetch EU sanctions results for the person (matched by name, potential false positives) / Buscar sanções da UE para a pessoa (busca por nome, potenciais falsos positivos)

fetch_pep_and_sanctionsboolean

Dispatches CGU PEP plus the Exato Sanctions aggregated query (includes OFAC, UN, EU and other restrictive/criminal datasets). / Dispara CGU PEP junto com a consulta agregada Exato Sanctions (inclui OFAC, UN, UE e outros datasets restritivos/criminais).

fetch_black_listsboolean

Fetch black lists entries (various) / Buscar em listas negras (diversas)

fetch_sports_betting_restrictionsboolean

Fetch sports betting restrictions (Brazilian lists only) / Buscar restrições de apostas esportivas (listas brasileiras apenas)

fetch_additional_attributesboolean

Fetch additional CPF attributes, currently: sex and mother's full name / Buscar atributos adicionais do CPF, atualmente: sexo e nome completo da mãe

fetch_contact_informationboolean

Fetch contact information, like phones, emails and addressss (if allowed and available) / Buscar informações de contato como telefones, emails e endereços (se permitido e disponível)

fetch_full_registration_databoolean

Return the full result of the Exato Cadastro Pessoa Física query (same content as /br/exato/cadastro/pessoa-fisica, without related people) in ExatoCadastro / Retornar o resultado completo da consulta Exato Cadastro Pessoa Física (mesmo conteúdo de /br/exato/cadastro/pessoa-fisica, sem relacionados) em ExatoCadastro

require_cpf_pdf_proofboolean

Require a freshly issued Receita Federal CPF proof (PDF): the CPF query never reuses previous results and only succeeds with a PDF, returned in ReceitaFederalCpfOnline.PdfUrl / Exigir um comprovante em PDF da Receita Federal emitido na hora: a consulta de CPF nunca reaproveita resultados anteriores e só tem sucesso com o PDF, devolvido em ReceitaFederalCpfOnline.PdfUrl

return_only_masked_databoolean

Return only masked data, safe for public/open display / Retornar apenas dados mascarados, seguros para exibição pública

address_streetstring

NOT CURRENTLY USED / NÃO UTILIZADO

address_numberstring

NOT CURRENTLY USED / NÃO UTILIZADO

address_complementstring

NOT CURRENTLY USED / NÃO UTILIZADO

address_districtstring

NOT CURRENTLY USED / NÃO UTILIZADO

address_zip_codestring

NOT CURRENTLY USED / NÃO UTILIZADO

address_citystring

NOT CURRENTLY USED / NÃO UTILIZADO

address_statestring

NOT CURRENTLY USED / NÃO UTILIZADO

rg_numerostring

NOT CURRENTLY USED / NÃO UTILIZADO

rg_orgao_expedidorstring

NOT CURRENTLY USED / NÃO UTILIZADO

rg_uf_expedidorstring

NOT CURRENTLY USED / NÃO UTILIZADO

cnh_numero_registrostring

NOT CURRENTLY USED / NÃO UTILIZADO

cnh_categoriastring

NOT CURRENTLY USED / NÃO UTILIZADO

cnh_codigo_situacaostring

NOT CURRENTLY USED / NÃO UTILIZADO

cnh_data_ultima_emissaostring

NOT CURRENTLY USED / NÃO UTILIZADO

cnh_data_validadestring

NOT CURRENTLY USED / NÃO UTILIZADO

cnh_data_primeira_habilitacaostring

NOT CURRENTLY USED / NÃO UTILIZADO

cnh_registro_nacional_estrangeirostring

NOT CURRENTLY USED / NÃO UTILIZADO

cnh_possui_impedimentostring

NOT CURRENTLY USED / NÃO UTILIZADO

cnh_observacoesstring

NOT CURRENTLY USED / NÃO UTILIZADO

try_match_cpf_and_phone_numberboolean

Try to confirm if the mobile phone number belong the CPF using mobile operators, avoiding a confirmation SMS (Brazilian phones only) / Tentar confirmar vínculo entre CPF e número de telefone usando as operadores, poupando o envio de um SMS (só para telefones brasileiros)

always_send_sms_confirmation_code_to_phoneboolean

Always send SMS confirmation message to phone number, independently of positive or negative match using the parameter try_match_cpf_and_phone_number / Sempre enviar SMS com código de confirmação para o telefone, tendo ou não vínculo confirmado usando o parâmetro try_match_cpf_and_phone_number

send_sms_confirmation_code_to_phone_when_not_matchboolean

Send SMS only in case of negative match using the the parameter try_match_cpf_and_phone_number / Enviar SMS de confirmação para telefone apenas em caso de não existência de vínculo positivo usando o parâmetro try_match_cpf_and_phone_number

sms_confirmation_message_templatestring

SMS confirmation message template, using the string '{0}' as the automatically generated code placeholder / Template de SMS de confirmação, usando a string '{0}' como placeholder para o código gerado automaticamente

sms_confirmation_messagestring

Full SMS confirmation message (not a template) to be sent to phone number, the consumer should generate the desired confirmation code as part of this parameter value / Mensagem SMS completa (não template) a ser enviada para o telefone, sendo que o consumidor deve gerar e especificar o código de confirmação dentro do valor desse parâmetro

fetch_lawsuitsboolean

Fetch Lawsuits (historical data) from the CPF / Buscar processos (dados históricos) do CPF

split_person_nameboolean

Split the person's name into First, Middle and Last / Separa o nome completo da pessoa em nome, nome do meio (quando existir) e sobrenome

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

No operation changes recorded.