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

Foto de la cara per analitzar (p. ex., una selfie). Envia una única foto frontal amb la cara de l'individu clarament visible i ben il·luminada. Extensions permeses: tiff, jpg, jpeg, png, webp (no s'admet PDF). Mida màxima de càrrega: 5 MB (els fitxers més grans es rebutgen amb un error 400). Les imatges es comprimeixen automàticament a ~0,3 MB abans del processament, de manera que resolucions molt altes no milloren la precisió.

face_liveness_score_decline_threshold
number<float>
predeterminat:30

Llindar de prova de vida (0–100). Una score de prova de vida igual o inferior a aquest valor afegeix una advertència LOW_LIVENESS_SCORE i rebutja. 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

age_estimation_decline_threshold
integer
predeterminat:18

Edat estimada mínima acceptable en anys. Una edat estimada per sota d'aquest valor afegeix una advertència AGE_BELOW_MINIMUM i rebutja. Estableix 0 per desactivar la comprovació d'edat (aleshores la crida només executa la prova de vida + estimació d'edat sense una decisió basada en l'edat).

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

18

rotate_image
boolean
predeterminat:false

Quan és true, el servei prova la imatge d'entrada en increments de 90 graus (0, 90, 180, 270) i utilitza l'orientació que ofereix la millor detecció facial — útil per a captures mòbils a les quals falta l'orientació EXIF. Afegeix latència, de manera que activa'l només si no pots garantir imatges orientades correctament.

Exemple:

false

save_api_request
boolean
predeterminat:true

Quan és true (per defecte), manté la crida com una sessió de tipus API — visible a la Business Console, recuperable mitjançant GET /v3/session/{sessionId}/decision/ utilitzant el request_id retornat, anunciada a través d'un webhook status.updated i amb la cara detectada afegida a l'índex facial de la teva aplicació. Quan és false, no s'emmagatzema res i request_id és un UUID transitori només per a la correlació de la resposta.

Exemple:

true

vendor_data
string

Cadena opaca opcional (el teu ID d'usuari intern, correu electrònic, UUID…) desada a la sessió persistent i retornada a la resposta. Utilitza-la per correlacionar crides a l'API amb els teus propis registres i per filtrar sessions més endavant.

Exemple:

"user-123"

metadata
object

Objecte JSON opcional emmagatzemat amb la sessió (quan save_api_request=true) i retornat a la resposta. En sol·licituds multipart, envia'l com a camp de cadena codificat en JSON (p. ex., metadata={"flow":"age-gate"}); s'analitza com un objecte.

Exemple:

Resposta

Estimació d'edat i prova de vida passiva completades. age_estimation.age_estimation és l'edat en anys predita pel model de la cara detectada més gran (null si no n'hi ha cap); age_estimation.score és la puntuació de prova de vida passiva (0–100); status és Approved només quan warnings està buit. Una captura d'un menor d'edat o amb suplantació continua retornant 200 amb status: "Declined" — inspecciona el cos, 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.

age_estimation
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.

Darrera modificació el 7 de novembre del 2026