Pular para o conteúdo principal
POST
cURL

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

multipart/form-data
user_image
file
obrigatório

Imagem frontal do rosto a ser usada na busca. Extensões permitidas: tiff, jpg, jpeg, png, webp. Tamanho máximo de upload: 5 MB (arquivos maiores são rejeitados com 400). As imagens são comprimidas automaticamente para ~0,5 MB antes do processamento, portanto resoluções muito altas não melhoram a precisão. A imagem deve conter pelo menos um rosto detectável; caso contrário, o endpoint retorna 400. Quando há vários rostos, a busca é feita pelo maior e um aviso MULTIPLE_FACES_DETECTED é adicionado.

search_type
enum<string>
padrão:most_similar

Política de busca. most_similar (padrão) classifica todos os rostos cadastrados na sua aplicação por similaridade. blocklisted_or_approved restringe os candidatos a rostos da lista de bloqueio, rostos da lista de permissões, rostos de sessões aprovadas e rostos importados de perfis de usuário — com as entradas da lista de bloqueio classificadas primeiro.

Opções disponíveis:
most_similar,
blocklisted_or_approved
Exemplo:

"most_similar"

rotate_image
boolean
padrão:false

Quando true, o serviço testa rotações de 90 graus da entrada e usa a orientação que produz a melhor detecção de rosto. Útil quando a orientação EXIF está ausente. Aumenta a latência.

Exemplo:

false

save_api_request
boolean
padrão:true

Quando true (padrão), persiste a chamada como uma sessão do tipo API, emite um webhook status.updated, gera URLs pré-assinadas para os valores de match_image_url e cadastra o rosto pesquisado no seu índice de busca facial (os cadastros da Busca facial são excluídos de buscas futuras). Quando false, a busca é avulsa: nenhuma sessão é armazenada e o rosto não é cadastrado.

Exemplo:

true

vendor_data
string

Identificador opaco opcional (seu ID de usuário, e-mail, UUID…) armazenado na sessão persistida e devolvido. Ele não exclui rostos do mesmo usuário dos resultados da busca.

Exemplo:

"user-123"

metadata
object

Objeto JSON opcional armazenado com a sessão (quando save_api_request=true) e devolvido. Em requisições multipart, envie-o como um campo de string codificada em JSON, que é convertido em um objeto.

Exemplo:

Resposta

Busca facial concluída. face_search.matches contém até 5 rostos semelhantes ordenados por similaridade; um array vazio significa que nenhum rosto cadastrado ultrapassou o limite mínimo de similaridade. status é Declined apenas em ocorrências na lista de bloqueio: correspondências duplicadas por si só retornam Approved, portanto verifique matches e warnings, não apenas status. Quando save_api_request=true, request_id é o ID da sessão persistida. Cada correspondência traz source (session, imported, list_entry ou retained_template), vendor_user_id e biometric_template_id; uma correspondência retained_template vem de um template biométrico sem imagem mantido após a exclusão da sessão de origem e tem campos de sessão, match_image_url e user_details como null.

request_id
string<uuid>

ID da sessão persistida quando save_api_request=true (utilizável com GET /v3/session/{sessionId}/decision/); caso contrário, um UUID de correlação transitório.

vendor_data
string | null

Eco do vendor_data que você enviou, ou null.

metadata
object | null

Eco do objeto metadata que você enviou, ou null.

created_at
string<date-time>

Timestamp ISO 8601 (UTC) do momento em que a resposta foi gerada, por exemplo 2026-06-12T01:04:42.763237+00:00.

Última modificação em 1 de novembro de 2026