Saltar al contingut principal
POST
cURL

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Cos

multipart/form-data
user_image
file
requerit

Imatge frontal del rostre (p. ex., una selfie). Extensions permeses: tiff, jpg, jpeg, png, webp. Mida màxima de càrrega: 5 MB (els fitxers més grans es rebutgen amb 400). Les imatges es comprimeixen automàticament a ~0.5 MB abans de processar-les, de manera que una resolució gaire alta no millora la precisió. La imatge ha de contenir un sol subjecte; si hi ha diverses cares presents, s'avalua la més gran i s'afegeix una advertència MULTIPLE_FACES_DETECTED.

face_liveness_score_decline_threshold
number<float>
predeterminat:30

Llindar de puntuació de prova de vida (0–100). Una puntuació calculada igual o inferior a aquest valor emet una advertència LOW_LIVENESS_SCORE i estableix status com a Declined. Per defecte és 30; augmenta'l per a una postura antisuplantació més estricta. Els valors fora de 0–100 retornen 400.

Rang requerit: 0 <= x <= 100
Exemple:

30

rotate_image
boolean
predeterminat:false

Quan és true, el servei prova rotacions de 90 graus de l'entrada i utilitza l'orientació que ofereix la millor detecció facial. Útil quan falta l'orientació EXIF. Afegeix latència.

Exemple:

false

save_api_request
boolean
predeterminat:true

Quan és true (per defecte), manté la crida com una sessió de tipus API, emmagatzema les imatges de la cara, emet un webhook status.updated i inscriu la cara detectada al teu índex de cerca facial. Quan és false, la crida és d'un sol ús: no s'emmagatzema res i la cara no s'inscriu. El cribratge de llistes de bloqueig i duplicats s'executa en ambdós casos.

Exemple:

true

vendor_data
string

Identificador opac opcional (el teu ID d'usuari, correu electrònic, UUID…) desat a la sessió persistent i retornat a la resposta. També s'utilitza per excloure sessions anteriors amb el mateix vendor_data de la comprovació de cares duplicades, de manera que reverificar el mateix usuari no genera DUPLICATED_FACE.

Exemple:

"user-123"

metadata
object

Objecte JSON opcional emmagatzemat amb la sessió (quan save_api_request=true) i retornat. En sol·licituds multipart, envia'l com a camp de cadena codificat en JSON; s'analitza com un objecte.

Exemple:

Resposta

Prova de vida passiva completada. liveness.score és la confiança del model de 0 a 100 que la imatge mostra una persona viva; status és Approved tret que s'hagi activat una advertència de gravetat error. Una cara suplantada o a la llista de bloqueig continua retornant 200 — inspecciona liveness.status i liveness.warnings, no només el codi HTTP. Quan save_api_request=true, request_id és l'id de la sessió persistida.

request_id
string<uuid>

ID de sessió persistida quan save_api_request=true (utilitzable amb GET /v3/session/{sessionId}/decision/); en cas contrari, un UUID de correlació transitori.

liveness
object
vendor_data
string | null

Ressò de les vendor_data que has enviat, o null.

metadata
object | null

Ressò de l'objecte metadata que has enviat, o null.

created_at
string<date-time>

Marca de temps ISO 8601 (UTC) de quan s'ha generat la resposta, p. ex. 2026-06-12T01:04:42.763237+00:00.

Darrera modificació el 7 de novembre del 2026