Saltar para o conteúdo principal
POST
Python
Submeter identificadores introduzidos e atributos de identidade declarados, selecionar as verificações a executar e analisar cada resultado separadamente. Utilize Planear uma verificação de fraude primeiro, para confirmar os requisitos de entrada e os custos estimados.

Escolher um perfil

Fixe profile_version para que os valores predefinidos selecionados e a política de decisão fiquem explícitos. O perfil predefinido é standard, versão 2026-08-27. A versão 2026-09-14 acrescenta o enriquecimento social opcional de e-mail e telefone e regista cada verificação concluída como uma sessão nativa de Verificação de utilizadores. Nessa versão, os complementos pagos são de adesão voluntária. A versão 2026-09-14.1 ativa também as pesquisas de identificadores na rede global de fraude para organizações do plano Enterprise que partilham dados globalmente. A versão 2026-09-14.2 acrescenta uma verificação de referência opcional entre selfie e CPF, para o Brasil. As versões anteriores mantêm o comportamento original. Os perfis atuais suportam risco de e-mail, risco de telefone, risco de IP, validação de base de dados elegível e o histórico da rede privada da sua aplicação. A vinculação de identidade baseada em selfie requer a versão 2026-09-14.2. Selecioná-la em versões anteriores devolve not_available_in_profile_version.

Identidade declarada e contexto

Coloque o e-mail, o telefone e os identificadores governamentais em subject.identifiers. Os identificadores governamentais exigem o respetivo país emissor; pode também ser necessário um emissor quando os números só são únicos dentro de uma região. Coloque os nomes, a data de nascimento, a nacionalidade e a morada em subject.attributes. Estes dados são declarações a comparar sempre que uma fonte selecionada as suporte, e não factos verificados só por terem sido submetidos. Use context para o endereço IP da tentativa, o agente do utilizador, a finalidade, o país e qualquer declaração de consentimento exigida. Isto separa as informações sobre a tentativa de verificação das informações sobre a pessoa. Para as verificações biométricas suportadas, forneça subject.selfie como JPEG, PNG ou WebP codificado em base64, até 6 MB. Também é aceite um URI de dados de imagem correspondente. Não envie uma imagem de referência, um URL remoto nem uma chave de armazenamento.

Selfie e identificador declarado

Selecione biometric_identity, submeta um identificador tax_number brasileiro e uma selfie, e confirme context.consent_obtained. A verificação de referência verifica se essa selfie pertence ao titular do CPF declarado. Um consentimento em falta devolve consent_required, e os países não suportados devolvem unsupported_region. O módulo tem um preço por verificação, baseado na taxa de Validação de base de dados da sua organização; consulte o plano antes de o executar. Quando a referência responde, identity_relationship.result é match, mismatch ou inconclusive. Uma resposta inconclusiva exige revisão e nunca é tratada como uma não correspondência. O resultado estabelece apenas a relação entre a selfie e o CPF. Não valida um nome ou uma data de nascimento submetidos, não comprova a existência de vida e não pesquisa uma face na internet ou na rede global de fraude. Os nomes e a data de nascimento continuam a ser dados declarados, salvo se outra fonte selecionada fornecer evidências para esses campos. Os tempos limite e os erros de fonte são resultados indisponíveis e não são faturados. As respostas inconclusivas concluídas são faturadas à mesma taxa de verificação de referência. A selfie não é incluída no resultado nem armazenada como ficheiro multimédia da sessão por esta verificação.

Selecionar verificações

checks.include seleciona os módulos, e checks.exclude tem precedência. Uma lista include explicitamente vazia desativa todo o trabalho opcional; a normalização continua a ser executada. Se omitir include, são usados os valores predefinidos do perfil fixado. O enriquecimento social de e-mail e de telefone é selecionado separadamente com email_social e phone_social. Ambos requerem um identificador válido e correspondente e não enviam um OTP.

Ler os resultados sem os confundir

Cada módulo indica o seu estado 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 em falta não é uma não correspondência de identidade nem um resultado de risco zero. attribute_evidence descreve as evidências ao nível do campo, enquanto risk mantém separadas as dimensões de identidade, contacto, dispositivo, comportamento e rede de fraude. Um e-mail, dispositivo ou outro identificador partilhado é uma ligação observada, e não prova que duas contas pertencem à mesma pessoa nem que houve fraude. recommendation é a recomendação da verificação; não altera o estado de outro registo. Os resultados do enriquecimento social aparecem em enrichment, distinguindo os resultados indisponíveis dos concluídos.

Rede global de fraude

Selecione networks_cross_org para consultar, na rede partilhada, os identificadores suportados de correio eletrónico, telefone e documento com o espaço de nomes corretamente definido. A consulta requer o plano Enterprise e o modo de partilha da sua organização definido como global. Sem estes requisitos, o plano indica o módulo com available: false e availability_reason: "entitlement_required", e uma verificação que o selecione ignora-o com o estado skipped e o motivo entitlement_required. O mesmo motivo aplica-se quando as Networks não estão ativadas para a sua organização. As aplicações de sandbox não estão sujeitas ao plano nem ao modo de partilha: com um identificador suportado, o módulo é executado e devolve um resultado de amostra vazio. A consulta utiliza o orçamento de leituras existente da organização e regista uma auditoria da leitura. Não tem cobrança por consulta. Planear uma verificação não consulta o índice partilhado nem consome o respetivo orçamento de leituras. network.cross_organization contém signals_checked e os insights agregados divulgados quando a verificação termina. Cada insight contém o tipo de sinal, as classes de resultado, o número de contribuidores, o intervalo de recência e, apenas quando a divulgação está ativada, as categorias de setor. Nunca identifica outra organização, conta, pessoa ou verificação. Os resultados abaixo do limiar de divulgação são omitidos; uma lista vazia não prova a ausência de histórico de fraude. Um sinal partilhado divulgado gera uma recomendação de revisão, nunca uma rejeição automática nem uma correspondência de identidade. Uma consulta indisponível indica o motivo separadamente de uma consulta concluída mas vazia. Se a sua organização perder mais tarde o acesso entre organizações, por exemplo após uma alteração de plano ou quando a partilha deixar de ser global, a obtenção de resultados, as novas tentativas e os detalhes da sessão ocultam os agregados partilhados e as respetivas evidências de risco derivadas. A recomendação original mantém-se como decisão histórica; as leituras não alteram o estado da verificação.

Sessões, novas tentativas e cobranças

check_id obtém o resultado guardado através de Obter uma verificação de fraude. Quando presente, request_id identifica a respetiva sessão de verificação nativa. As versões 2026-09-14, 2026-09-14.1 e 2026-09-14.2 criam sempre essa sessão, mesmo quando só é selecionado o histórico da rede privada. Reutilizar client_reference com o mesmo corpo do pedido devolve o resultado original, sem nova execução nem cobrança, enquanto essa verificação existir. Um corpo diferente com a mesma referência devolve 409. Se a execução ainda estiver em curso, tente novamente o mesmo pedido após o intervalo indicado em Retry-After na resposta. Eliminar a verificação associada também elimina o resultado da verificação de fraude; a obtenção devolve depois 404. Uma verificação eliminada durante a execução não pode publicar um resultado concluído. Os preços provêm das tarifas pré-pagas ou contratuais atuais da sua organização. Os módulos indisponíveis e ignorados não são faturados, e o histórico da rede privada não tem cobrança por verificação. As verificações em sandbox utilizam respostas de amostra, sem chamadas pagas a fornecedores nem cobranças.

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Corpo

subject
object
obrigatório
client_reference
string

A sua própria referência para esta verificação. Funciona também como a chave de idempotência: reutilizá-la com o mesmo corpo devolve a verificação original sem executar ou faturar os módulos novamente; reutilizá-la com um corpo diferente devolve 409.

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

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

Required string length: 1 - 64
profile_version
string

Fixar uma versão congelada do perfil. Assume por predefiniçã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 - Falhado
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 - Rever
  • reject - Rejeitar
Opções disponíveis:
approve,
review,
reject
next_action
enum<string>
obrigatório
  • none - Nenhum
  • manual_review - Revisão manual
  • step_up - Escalonamento
  • 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 7 de novembro de 2026