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 frontal (por exemplo, uma selfie). 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 altas não melhoram a precisão. A imagem deve conter um único sujeito — quando vários rostos estão presentes, o maior é avaliado e um aviso MULTIPLE_FACES_DETECTED é adicionado.

face_liveness_score_decline_threshold
number<float>
padrão:30

Limiar da pontuação de prova de vida (0–100). Uma pontuação calculada igual ou inferior a este valor emite um aviso LOW_LIVENESS_SCORE e define o status como Declined. Predefinição 30; aumente-o para uma postura antispoofing mais rigorosa. Valores fora de 0–100 devolvem 400.

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

30

rotate_image
boolean
padrão:false

Quando true, o serviço tenta rotações de 90 graus da entrada e utiliza a orientação que produzir a melhor deteção facial. Útil quando a orientação EXIF está ausente. Adiciona 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, armazena as imagens do rosto, emite um webhook status.updated e regista o rosto detetado no seu índice de Pesquisa facial. Quando false, a chamada é de execução única — nada é armazenado e o rosto não é registado. A triagem de lista de bloqueio e de duplicados é executada em ambos os casos.

Exemplo:

true

vendor_data
string

Identificador opaco opcional (o seu ID de utilizador, e-mail, UUID...) guardado na sessão persistida e devolvido. Também é utilizado para excluir sessões anteriores com o mesmo vendor_data da verificação de rostos duplicados, para que a reverificação do mesmo utilizador não acione DUPLICATED_FACE.

Exemplo:

"user-123"

metadata
object

Objeto JSON opcional armazenado com a sessão (quando save_api_request=true) e devolvido. Em pedidos multipart, envie-o como um campo de texto codificado em JSON — é convertido num objeto.

Exemplo:

Resposta

Prova de vida passiva concluída. liveness.score é a confiança de 0 a 100 do modelo de que a imagem mostra uma pessoa viva; status é Approved, a menos que tenha sido acionado um aviso com gravidade error. Um rosto falsificado ou na lista de bloqueio continua a devolver 200 — inspecione liveness.status e liveness.warnings, e não apenas o código HTTP. Quando save_api_request=true, request_id é o ID da sessão persistida.

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.

liveness
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