Saltar para o conteúdo principal
POST
cURL

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

multipart/form-data
user_image
file
obrigatório

Imagem facial ao vivo ou candidata a verificar (por exemplo, uma selfie). Envie uma única fotografia frontal com o rosto do sujeito claramente visível e bem iluminado. Extensões permitidas: tiff, jpg, jpeg, png, webp. Tamanho máximo de carregamento: 5 MB (ficheiros maiores são rejeitados com 400). As imagens são comprimidas automaticamente para ~0.5 MB antes do processamento, pelo que resoluções muito elevadas não melhoram a precisão.

ref_image
file
obrigatório

Imagem facial de referência para comparação (por exemplo, a fotografia de um documento de identificação ou uma fotografia registada anteriormente). O mesmo formato e limites de tamanho que user_image.

face_match_score_decline_threshold
number<float>
padrão:30

Limiar de semelhança (0–100) que orienta o status da resposta. Uma pontuação calculada igual ou inferior a este valor define o status como Declined e adiciona um aviso LOW_FACE_MATCH_SIMILARITY; uma pontuação estritamente superior devolve Approved. O valor predefinido de 30 é permissivo — aumente-o (por exemplo, 50–60) para uma verificação mais rigorosa. Valores fora de 0–100 devolvem 400.

Intervalo necessário: 0 <= x <= 100
Exemplo:

50

rotate_image
boolean
padrão:false

Quando true, o serviço testa as imagens de entrada em incrementos de 90 graus (0, 90, 180, 270) e utiliza a orientação que produzir a melhor deteção facial — útil para capturas móveis sem orientação EXIF. Adiciona latência, pelo que só deve ativá-lo se não puder garantir imagens na orientação correta.

Exemplo:

false

save_api_request
boolean
padrão:true

Quando for true (predefinição), persiste a chamada como uma sessão do tipo API — visível na Business Console, recuperável através de GET /v3/session/{sessionId}/decision/ utilizando o request_id devolvido e anunciada através de um webhook status.updated. Quando for false, nada é armazenado e request_id é um UUID transitório apenas para correlação de respostas.

Exemplo:

true

vendor_data
string

String opaca opcional (o seu ID de utilizador interno, e-mail, UUID...) guardada na sessão persistida e devolvida na resposta. Utilize-a para correlacionar chamadas de API com os seus próprios registos e para filtrar sessões mais tarde.

Exemplo:

"user-123"

metadata
object

Objeto JSON opcional armazenado com a sessão (quando save_api_request=true) e devolvido na resposta. Em pedidos multipart, envie-o como um campo de texto codificado em JSON (por exemplo, metadata={"flow":"login"}) — é convertido num objeto.

Exemplo:

Resposta

Correspondência facial calculada. face_match.score é um número de ponto flutuante de 0–100 (duas casas decimais); status é Approved quando a pontuação está estritamente acima de face_match_score_decline_threshold, caso contrário é Declined com um aviso explicativo. Um par de baixa semelhança ou sem pontuação ainda devolve 200 — inspecione face_match.status e face_match.warnings, e não apenas o código HTTP. Quando save_api_request=true, request_id é o id de sessão persistido.

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.

face_match
object
vendor_data
string | null

Eco do vendor_data que enviou, ou null.

metadata
object | null

Eco do objeto metadata que enviou, ou null.

created_at
string<date-time>

Carimbo de data/hora ISO 8601 (UTC) de quando a resposta foi gerada, por exemplo 2026-06-12T01:04:42.763237+00:00.

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