Pular para o conteúdo principal
POST
Python
Envie identificadores digitados e atributos de identidade declarados, selecione as verificações a executar e analise cada resultado separadamente. Use primeiro Planejar uma verificação de fraude para conferir os requisitos de entrada e as cobranças estimadas.

Escolha um perfil

Fixe profile_version para que os padrões selecionados e a política de decisão fiquem explícitos. O perfil padrão é standard, versão 2026-08-27. A versão 2026-09-14 adiciona o enriquecimento social opcional de e-mail e telefone e registra cada verificação concluída como uma sessão nativa de Verificação de Usuário. Nessa versão, os complementos pagos precisam ser ativados explicitamente. A versão 2026-09-14.1 também ativa as consultas de identificadores na rede global de fraude para organizações no plano Enterprise que compartilham dados globalmente. A versão 2026-09-14.2 adiciona uma verificação opcional da selfie em relação à referência do CPF para o Brasil. As versões anteriores mantêm o comportamento original. Os perfis atuais oferecem suporte a risco de e-mail, risco de telefone, risco de IP, validação em bancos de dados elegíveis e ao histórico da rede privada da sua aplicação. A vinculação de identidade baseada em selfie exige a versão 2026-09-14.2. Selecioná-la em versões anteriores retorna not_available_in_profile_version.

Identidade declarada e contexto

Coloque e-mail, telefone e identificadores governamentais em subject.identifiers. Identificadores governamentais exigem o país emissor; um órgão emissor também pode ser necessário quando os números só são únicos dentro de uma região. Coloque nomes, data de nascimento, nacionalidade e endereço em subject.attributes. São declarações a serem comparadas quando uma fonte selecionada oferece suporte a elas, e não fatos verificados só porque foram enviados. Use context para o endereço IP da tentativa, o user agent, a finalidade, o país e qualquer declaração de consentimento exigida. Isso separa as informações sobre a tentativa de verificação das informações sobre a pessoa. Para as verificações biométricas compatíveis, envie subject.selfie como JPEG, PNG ou WebP codificado em base64, com até 6 MB. Um data URI de imagem correspondente também é aceito. Não envie uma imagem de referência, uma URL remota nem uma chave de armazenamento.

Selfie e identificador declarado

Selecione biometric_identity, envie um identificador tax_number brasileiro e uma selfie e confirme context.consent_obtained. A referência verifica se essa selfie pertence ao titular do CPF declarado. A falta de consentimento retorna consent_required, e países sem suporte retornam unsupported_region. O módulo tem um preço por verificação baseado na tarifa de validação de banco de dados da sua organização; consulte o plano antes de executar o módulo. Quando a referência responde, identity_relationship.result é match, mismatch ou inconclusive. Uma resposta inconclusiva exige revisão e nunca é tratada como divergência. O resultado estabelece apenas a relação entre a selfie e o CPF. Ele não valida um nome ou uma data de nascimento enviados, não comprova a vivacidade e não busca um rosto na internet nem na rede global de fraude. Nomes e data de nascimento continuam sendo declarações, a menos que outra fonte selecionada forneça evidências para esses campos. Tempos limite excedidos e erros da fonte são resultados indisponíveis e não são cobrados. Respostas inconclusivas finalizadas são cobradas pela mesma tarifa da verificação de referência. A selfie não é incluída no resultado nem armazenada como mídia da sessão por esta verificação.

Selecione as verificações

checks.include seleciona os módulos, e checks.exclude tem precedência. Uma lista include vazia e explícita desativa todo o processamento opcional; a normalização continua sendo executada. Omitir include usa os padrões do perfil fixado. O enriquecimento social de e-mail e de telefone é selecionado separadamente com email_social e phone_social. Eles exigem um identificador válido correspondente e não enviam um OTP.

Leia os resultados sem confundi-los

Cada módulo informa seu status de execução, o motivo e as unidades faturáveis. not_requested, excluded_by_caller, missing_required_input e source_unavailable descrevem resultados diferentes. Uma fonte ausente não é uma divergência de identidade nem um resultado de risco zero. attribute_evidence descreve as evidências por campo, enquanto risk mantém separadas as dimensões de identidade, contato, dispositivo, comportamento e rede de fraude. Um e-mail, dispositivo ou outro identificador compartilhado é uma conexão observada, e não uma prova de que duas contas pertencem à mesma pessoa ou cometeram fraude. recommendation é a recomendação da verificação; ela não altera o status de outro registro. Os resultados do enriquecimento social aparecem em enrichment, com os resultados indisponíveis diferenciados dos resultados concluídos.

Rede global de fraudes

Selecione networks_cross_org para consultar identificadores compatíveis de e-mail, telefone e documento na rede compartilhada, sendo que os identificadores de documento devem ter o namespace correto. A consulta exige o plano Enterprise e o modo de compartilhamento da sua organização definido como global. Sem esses requisitos, o plano informa o módulo com available: false e availability_reason: "entitlement_required", e uma checagem que o seleciona o ignora com status skipped e motivo entitlement_required. O mesmo motivo se aplica quando o Networks não está habilitado para a sua organização. Aplicações de sandbox não dependem do plano nem do modo de compartilhamento: com um identificador compatível, o módulo é executado e retorna um resultado de exemplo vazio. A consulta usa o orçamento de leitura já existente da organização e registra uma auditoria da leitura. Não há cobrança por consulta. Planejar uma checagem não consulta o índice compartilhado nem consome o orçamento de leitura dele. network.cross_organization contém signals_checked e os insights agregados divulgados quando a checagem é concluída. Cada insight contém o tipo de sinal, as classes de resultado, o número de contribuintes, a faixa de recência e as categorias de setor, estas apenas quando a divulgação está habilitada. Ele nunca identifica outra organização, conta, pessoa ou verificação. Resultados abaixo do limiar de divulgação são omitidos; uma lista vazia não comprova a ausência de histórico de fraude. Um sinal compartilhado divulgado gera uma recomendação de revisão, nunca uma rejeição automática nem uma correspondência de identidade. Uma consulta indisponível informa o motivo separadamente de uma consulta concluída vazia. Se a sua organização perder posteriormente o acesso entre organizações, por exemplo após uma mudança de plano ou quando o compartilhamento deixar de ser global, a recuperação de resultados, as novas tentativas e os detalhes da sessão ocultam os agregados compartilhados e as evidências de risco derivadas deles. A recomendação original permanece como uma decisão histórica; as leituras não alteram o status da verificação.

Sessões, novas tentativas e cobranças

check_id recupera o resultado armazenado por meio de Obter um Fraud Check. Quando presente, request_id identifica a sessão de verificação nativa correspondente. As versões 2026-09-14, 2026-09-14.1 e 2026-09-14.2 sempre criam essa sessão, inclusive quando apenas o histórico da rede privada é selecionado. Reutilizar client_reference com o mesmo corpo de requisição retorna o resultado original, sem nova execução nem cobrança, enquanto essa checagem existir. Um corpo diferente com a mesma referência retorna 409. Se a execução ainda estiver em andamento, tente novamente a mesma requisição após o intervalo indicado em Retry-After na resposta. Excluir a verificação associada também exclui o resultado do Fraud Check; a consulta passa a retornar 404. Uma checagem excluída durante a execução não pode publicar um resultado concluído. Os preços seguem as tarifas pré-pagas ou contratuais vigentes da sua organização. Módulos indisponíveis e ignorados não são cobrados, e o histórico da rede privada não tem cobrança por checagem. Checagens no sandbox usam respostas de exemplo, sem chamadas pagas a fornecedores nem cobranças.

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Corpo

subject
object
obrigatório
client_reference
string

Sua própria referência para esta verificação. Também funciona como chave de idempotência: reutilizá-la com o mesmo corpo retorna a verificação original sem executar nem cobrar os módulos novamente; reutilizá-la com um corpo diferente retorna 409.

Required string length: 1 - 255
profile
string
padrão:standard

ID do perfil de orquestração. O padrão é o perfil standard da Didit.

Required string length: 1 - 64
profile_version
string

Fixa uma versão congelada do perfil. O padrão é a versão atual do perfil.

Required string length: 1 - 32
context
object
checks
object
vendor_data
string
Maximum string length: 1000
metadata
any

Resposta

check_id
string<uuid>
obrigatório
client_reference
string | null
obrigatório
processing_status
enum<string>
obrigatório
  • pending - Pendente
  • running - Em execução
  • completed - Concluído
  • failed - Falhou
Opções disponíveis:
pending,
running,
completed,
failed
profile_id
string
obrigatório
profile_version
string
obrigatório
created_at
string<date-time>
obrigatório
completed_at
string<date-time> | null
obrigatório
inputs
object[]
obrigatório
modules
object[]
obrigatório
attribute_evidence
object[]
obrigatório
compound_evidence
object[]
obrigatório
risk
object[]
obrigatório
network
object
obrigatório
recommendation
enum<string>
obrigatório
  • approve - Aprovar
  • review - Revisar
  • reject - Rejeitar
Opções disponíveis:
approve,
review,
reject
next_action
enum<string>
obrigatório
  • none - Nenhuma
  • manual_review - Revisão manual
  • step_up - Verificação adicional
  • resubmit_capture - Reenviar captura
Opções disponíveis:
none,
manual_review,
step_up,
resubmit_capture
decision_reasons
string[]
obrigatório
coverage
object
obrigatório
usage
object[]
obrigatório
request_id
string<uuid>

Sessão de verificação nativa criada para esta verificação.

enrichment
object
identity_relationship
object | null
vendor_data
string | null
metadata
unknown
Última modificação em 1 de novembro de 2026