> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Confronto facciale 1:1 API: Face Match di Didit > Didit: confronto facciale 1:1 via POST /v3/face-match/. Verifica identità, nuova verifica. Sotto 2s, prezzi a consumo, nessun minimo. ## OpenAPI ````yaml it/openapi-25.json POST /v3/face-match/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API di verifica dell'identità. Autenticati con l'intestazione x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/face-match/: post: tags: - Standalone APIs summary: Confronto facciale description: >- Confronta due immagini di volti (1:1) e ottieni un punteggio (`score`) di somiglianza (0–100) oltre a uno stato (`status`) `Approved`/`Declined`. **Come funziona.** Entrambe le immagini vengono decodificate e analizzate da un modello biometrico (imposta `rotate_image=true` se le acquisizioni potrebbero essere ruotate o capovolte), quindi viene calcolato un punteggio di somiglianza tra i due volti. Un punteggio **strettamente superiore** a `face_match_score_decline_threshold` (predefinito `30`) restituisce `status: "Approved"`; un punteggio pari o inferiore restituisce `Declined` con un avviso `LOW_FACE_MATCH_SIMILARITY`. Se non è possibile calcolare il punteggio per nessuna coppia di volti, la chiamata restituisce comunque `200` con `status: "Declined"` e un avviso `NO_REFERENCE_IMAGE` — `score` è `null` sul percorso di salvataggio predefinito, o `0` con `save_api_request=false`. Per ottenere risultati ottimali, invia un unico volto nitido e rivolto frontalmente per immagine. **Fatturazione.** Ciascuna risposta `200` consuma un credito API di Confronto facciale (scalato dal credito del piano o dal saldo delle ricariche). Se il saldo dell'organizzazione non copre la chiamata, l'endpoint restituisce `403` con l'errore di crediti insufficienti prima di qualsiasi elaborazione delle immagini. **Persistenza della sessione (`save_api_request`, predefinito `true`).** Quando è `true`, la chiamata viene salvata come sessione di tipo API: compare nella Business Console, il `request_id` restituito è un ID di sessione reale che puoi passare a `GET /v3/session/{sessionId}/decision/`, entrambe le immagini vengono archiviate come immagini sorgente/destinazione del confronto facciale della sessione e viene emesso un webhook `status.updated` verso le tue destinazioni webhook configurate. Quando è `false`, non viene memorizzato nulla e `request_id` è un UUID di correlazione monouso che non può essere consultato in seguito. **Indice di ricerca facciale.** Questo endpoint non registra mai volti nel tuo indice di ricerca facciale e non esegue mai screening di blocklist o duplicati — usa `POST /v3/passive-liveness/` o `POST /v3/face-search/` per queste operazioni. **Sandbox.** Le chiavi API sandbox ignorano ogni elaborazione e fatturazione: dopo la validazione della richiesta (l'input malformato restituisce comunque `400`), l'endpoint restituisce un payload fittizio statico `Approved`, non viene salvata alcuna sessione e non viene consumato alcun credito. **Autenticazione.** Invia la chiave API della tua applicazione nell'intestazione `x-api-key`. Credenziali mancanti o non valide restituiscono `403` (`{"detail": "You do not have permission to perform this action."}`) — questa API non restituisce mai `401`. **Limite di frequenza.** Limite condiviso per le operazioni di scrittura di 300 richieste/min per chiave API su tutti gli endpoint POST/PATCH/DELETE; il superamento restituisce `429`. operationId: post_v3face-match parameters: [] requestBody: required: true content: multipart/form-data: schema: type: object required: - user_image - ref_image properties: user_image: type: string format: binary description: >- Immagine del volto dal vivo o candidata da verificare (es. un selfie). Invia una singola foto frontale con il volto del soggetto chiaramente visibile e ben illuminato. Estensioni consentite: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Dimensione massima di caricamento: **5 MB** (i file più grandi vengono rifiutati con `400`). Le immagini vengono compresse automaticamente a circa 0,5 MB prima dell'elaborazione, quindi risoluzioni molto elevate non migliorano la precisione. ref_image: type: string format: binary description: >- Immagine del volto di riferimento con cui effettuare il confronto (es. la fototessera di un documento d'identità o una foto registrata in precedenza). Stessi limiti di formato e dimensione di `user_image`. face_match_score_decline_threshold: type: number format: float default: 30 minimum: 0 maximum: 100 description: >- Soglia di somiglianza (0–100) che determina lo `status` della risposta. Un punteggio calcolato **pari o inferiore** a questo valore imposta `status` su `Declined` e aggiunge un avviso `LOW_FACE_MATCH_SIMILARITY`; un punteggio rigorosamente superiore restituisce `Approved`. Il valore predefinito `30` è permissivo — aumentalo (ad es. `50`–`60`) per una verifica più rigorosa. I valori al di fuori di 0–100 restituiscono `400`. example: 50 rotate_image: type: boolean default: false description: >- Quando è `true`, il servizio prova le immagini di input con incrementi di 90 gradi (0, 90, 180, 270) e utilizza l'orientamento che offre il miglior rilevamento del volto; utile per le acquisizioni da dispositivo mobile prive di orientamento EXIF. Aggiunge latenza, quindi attivalo solo se non puoi garantire immagini orientate correttamente. example: false save_api_request: type: boolean default: true description: >- Quando è `true` (predefinito), rende persistente la chiamata come sessione di tipo API — visibile nella Business Console, recuperabile tramite `GET /v3/session/{sessionId}/decision/` utilizzando il `request_id` restituito, e notificata tramite un webhook `status.updated`. Quando è `false`, non viene memorizzato nulla e `request_id` è un UUID temporaneo utilizzabile solo per la correlazione della risposta. example: true vendor_data: type: string description: >- Stringa opaca opzionale (il tuo ID utente interno, email, UUID...) memorizzata nella sessione persistita e restituita nella risposta. Usala per correlare le chiamate API con i tuoi record e per filtrare le sessioni in un secondo momento. example: user-123 metadata: type: object additionalProperties: true description: >- Oggetto JSON opzionale memorizzato con la sessione (quando `save_api_request=true`) e restituito nella risposta. Nelle richieste multipart, invialo come campo stringa con codifica JSON (ad es. `metadata={"flow":"login"}`) — viene interpretato come oggetto. example: flow: login device_id: abc123 example: user_image: (binary JPEG/PNG of the live selfie) ref_image: (binary JPEG/PNG of the reference photo) face_match_score_decline_threshold: 50 rotate_image: false save_api_request: true vendor_data: user-123 metadata: flow: login responses: '200': description: >- Confronto facciale calcolato. `face_match.score` è un numero decimale compreso tra 0 e 100 (due cifre decimali); `status` è `Approved` quando il punteggio è strettamente superiore a `face_match_score_decline_threshold`, altrimenti `Declined` con un avviso esplicativo. Una coppia con bassa somiglianza o non valutabile restituisce comunque `200`: esamina `face_match.status` e `face_match.warnings`, non solo il codice HTTP. Quando `save_api_request=true`, `request_id` è l'ID della sessione salvata. content: application/json: examples: Approved: summary: Stessa persona — punteggio superiore alla soglia value: request_id: f9f5a777-8002-44c6-baaf-128bcfd6e226 face_match: status: Approved score: 99.41 user_image: entities: - bbox: - 661 - 728 - 1688 - 2188 confidence: 0.732973 age: 26.91 gender: male race: null best_angle: 0 ref_image: entities: - bbox: - 653 - 745 - 1691 - 2185 confidence: 0.722082 age: 27 gender: male race: null best_angle: 0 warnings: [] vendor_data: user-123 metadata: flow: login created_at: '2026-06-12T01:04:42.763237+00:00' Declined - low similarity: summary: Punteggio pari o inferiore alla soglia di rifiuto value: request_id: 7cdda24e-311a-46d3-a3bb-e5d9b564ce73 face_match: status: Declined score: 24.87 user_image: entities: - bbox: - 661 - 728 - 1688 - 2188 confidence: 0.732973 age: 26.91 gender: male race: null best_angle: 0 ref_image: entities: - bbox: - 156 - 234 - 679 - 898 confidence: 0.717775 age: 41.2 gender: male race: null best_angle: 0 warnings: - risk: LOW_FACE_MATCH_SIMILARITY feature: FACEMATCH additional_data: null log_type: error short_description: Low face match similarity long_description: >- The facial features of the provided image don't closely match the reference image, suggesting a potential identity mismatch. vendor_data: user-123 metadata: null created_at: '2026-06-12T01:08:19.859116+00:00' schema: type: object properties: request_id: type: string format: uuid description: >- ID della sessione salvata quando `save_api_request=true` (utilizzabile con `GET /v3/session/{sessionId}/decision/`); altrimenti un UUID di correlazione temporaneo. face_match: type: object properties: status: type: string enum: - Approved - Declined description: >- `Approved` quando il punteggio di somiglianza è strettamente superiore a `face_match_score_decline_threshold` ed è stato possibile calcolare un punteggio; `Declined` in caso contrario (un avviso ne spiega il motivo). score: type: number format: float nullable: true minimum: 0 maximum: 100 description: >- Punteggio di somiglianza da 0 a 100 — la confidenza del modello che entrambe le immagini ritraggano la stessa persona. Arrotondato a due decimali solo quando `save_api_request` è true; con `save_api_request=false` viene restituito il float non elaborato. `null` quando non è stato possibile calcolare il punteggio per nessuna coppia di volti (con il valore predefinito `save_api_request=true`); con `save_api_request=false` la stessa condizione può presentarsi come `score: 0`. In entrambi i casi è presente un avviso `NO_REFERENCE_IMAGE` e `status` è `Declined`. example: 99.41 user_image: type: object description: >- Risultati del rilevamento facciale per le immagini analizzate. properties: entities: type: array items: type: object properties: bbox: type: array items: type: integer minItems: 4 maxItems: 4 description: >- Riquadro di delimitazione del volto rilevato come coordinate in pixel `[x_min, y_min, x_max, y_max]` nell'immagine elaborata. example: - 661 - 728 - 1688 - 2188 confidence: type: number format: float minimum: 0 maximum: 1 description: Affidabilità del rilevamento facciale (0–1). example: 0.732973 age: type: number format: float description: >- Età stimata dal modello per il volto rilevato, in anni. Solo a scopo informativo: non influisce sulla decisione del confronto facciale. example: 26.91 gender: type: string description: >- Genere previsto dal modello per il volto rilevato (`male` o `female`). Solo a scopo informativo. example: male race: type: string nullable: true description: >- Campo riservato — sempre `null` nelle risposte di questo endpoint. example: null description: Una voce per ogni volto rilevato. best_angle: type: integer description: >- Rotazione (gradi: 0, 90, 180 o 270) che ha prodotto il miglior rilevamento del volto. Diversa da zero solo quando `rotate_image=true` ha corretto l'orientamento. example: 0 ref_image: type: object description: >- Risultati del rilevamento facciale per l'immagine di riferimento, con la stessa struttura di `user_image`. properties: entities: type: array items: type: object properties: bbox: type: array items: type: integer minItems: 4 maxItems: 4 description: >- Riquadro di delimitazione del volto rilevato come coordinate in pixel `[x_min, y_min, x_max, y_max]` nell'immagine elaborata. example: - 661 - 728 - 1688 - 2188 confidence: type: number format: float minimum: 0 maximum: 1 description: Affidabilità del rilevamento facciale (0–1). example: 0.732973 age: type: number format: float description: >- Età stimata dal modello per il volto rilevato, in anni. Solo a scopo informativo: non influisce sulla decisione del confronto facciale. example: 26.91 gender: type: string description: >- Genere previsto dal modello per il volto rilevato (`male` o `female`). Solo a scopo informativo. example: male race: type: string nullable: true description: >- Campo riservato — sempre `null` nelle risposte di questo endpoint. example: null description: Una voce per ogni volto rilevato. best_angle: type: integer example: 0 warnings: type: array description: >- Vuoto in caso di approvazione senza anomalie. `NO_REFERENCE_IMAGE` (`error`): impossibile valutare alcuna coppia di volti; `LOW_FACE_MATCH_SIMILARITY` (`error`): punteggio pari o inferiore alla soglia di rifiuto. Ciascuno di questi imposta `status` su `Declined`. items: type: object properties: risk: type: string enum: - NO_REFERENCE_IMAGE - LOW_FACE_MATCH_SIMILARITY description: Codice di rischio leggibile dalla macchina. feature: type: string enum: - FACEMATCH description: >- Funzionalità che ha generato l'avviso. Sempre `FACEMATCH` su questo endpoint. additional_data: type: object nullable: true additionalProperties: true description: >- Sempre `null` per gli avvisi relativi al confronto facciale. log_type: type: string enum: - error - warning - information description: >- Gravità. Gli avvisi `error` portano `status` a `Declined`; le voci `warning` e `information` sono informative e non determinano mai un rifiuto da sole. short_description: type: string description: >- Riepilogo del rischio su una riga leggibile dall'utente. long_description: type: string description: Spiegazione di facile lettura del rischio. vendor_data: type: string nullable: true description: Eco del `vendor_data` inviato, o `null`. metadata: type: object nullable: true additionalProperties: true description: Eco dell'oggetto `metadata` inviato, o `null`. created_at: type: string format: date-time description: >- Timestamp ISO 8601 (UTC) di generazione della risposta, ad es. `2026-06-12T01:04:42.763237+00:00`. '400': description: >- Errore di validazione. Restituito quando un'immagine obbligatoria è mancante, supera 5 MB, ha un'estensione non supportata o quando un'opzione è fuori intervallo. Il corpo è l'envelope standard degli errori di campo di DRF: un array di messaggi per ciascun campo interessato. content: application/json: examples: Missing required image: summary: '`ref_image` (o `user_image`) non inclusa nei dati del modulo' value: ref_image: - No file was submitted. Unsupported file extension: summary: Estensione del file diversa da tiff/jpg/jpeg/png/webp value: user_image: - >- File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp. File too large: summary: Il caricamento supera il limite di 5 MB value: user_image: - File size should not exceed 5 MB Threshold out of range: summary: '`face_match_score_decline_threshold` al di fuori di 0–100' value: face_match_score_decline_threshold: - Ensure this value is less than or equal to 100. '403': description: >- Autorizzazione negata. Restituito quando l'intestazione `x-api-key` è mancante e anche quando il saldo dell'organizzazione chiamante non è sufficiente a coprire la chiamata; una chiave errata, revocata o scaduta restituisce `401`. Una chiave mancante restituisce `403` con `{"detail": ...}`; una chiave errata, revocata o scaduta restituisce `401`. Crediti insufficienti restituiscono `403` con `{"error": ...}` prima che avvenga qualsiasi elaborazione delle immagini. content: application/json: examples: Missing or invalid API key: summary: >- Nessuna intestazione `x-api-key`, oppure la chiave non è valida/revocata value: detail: You do not have permission to perform this action. Not enough credits: summary: >- Il saldo dell'organizzazione non è sufficiente per coprire la chiamata value: error: >- You don't have enough credits to perform this request. Please top up at https://business.didit.me '429': description: >- Limite di frequenza superato. Gli endpoint POST/PATCH/DELETE condividono un budget di 300 richieste di scrittura al minuto per chiave API (la creazione di transazioni e l'ingestione di eventi hanno un budget separato di 600). La risposta contiene le intestazioni `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`. content: application/json: examples: Write rate limit exceeded: summary: Più di 300 richieste di scrittura nel minuto corrente value: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. schema: type: object properties: detail: type: string security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: cURL source: |- curl -X POST 'https://verification.didit.me/v3/face-match/' \ -H 'x-api-key: YOUR_API_KEY' \ -F 'user_image=@./selfie.jpg' \ -F 'ref_image=@./id_portrait.jpg' \ -F 'face_match_score_decline_threshold=50' \ -F 'save_api_request=true' \ -F 'vendor_data=user-123' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.face_match.compare( user_image=open("user_image.jpg", "rb"), ref_image=open("ref_image.jpg", "rb"), face_match_score_decline_threshold=50.0, rotate_image=False, save_api_request=True, vendor_data="user-123", metadata={"flow": "login"}, ) print(result) - lang: javascript label: Node.js source: |- import Didit, { fileFromPath } from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.faceMatch.compare({ user_image: await fileFromPath("user_image.jpg"), ref_image: await fileFromPath("ref_image.jpg"), face_match_score_decline_threshold: 50.0, rotate_image: false, save_api_request: true, vendor_data: "user-123", metadata: { flow: "login" }, }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FaceMatch.Compare(ctx, didit.FaceMatchCompareParams{\n\tUserImage: didit.FileFromPath(\"user_image.jpg\"),\n\tRefImage: didit.FileFromPath(\"ref_image.jpg\"),\n\tFaceMatchScoreDeclineThreshold: didit.Float(50.0),\n\tRotateImage: didit.Bool(false),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"login\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import java.nio.file.Path; import java.util.Map; import me.didit.Didit; import me.didit.types.FaceMatchCompareParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.faceMatch().compare(FaceMatchCompareParams.builder() .userImage(Path.of("user_image.jpg")) .refImage(Path.of("ref_image.jpg")) .faceMatchScoreDeclineThreshold(50.0) .rotateImage(false) .saveApiRequest(true) .vendorData("user-123") .metadata(Map.of("flow", "login")) .build()); System.out.println(result); - lang: php label: PHP source: |- faceMatch->compare([ 'user_image' => File::fromPath('user_image.jpg'), 'ref_image' => File::fromPath('ref_image.jpg'), 'face_match_score_decline_threshold' => 50.0, 'rotate_image' => false, 'save_api_request' => true, 'vendor_data' => 'user-123', 'metadata' => ['flow' => 'login'], ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.face_match.compare( user_image: Pathname("user_image.jpg"), ref_image: Pathname("ref_image.jpg"), face_match_score_decline_threshold: 50.0, rotate_image: false, save_api_request: true, vendor_data: "user-123", metadata: { flow: "login" } ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Collections.Generic; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.FaceMatch.CompareAsync(new FaceMatchCompareParams { UserImage = FileUpload.FromPath("user_image.jpg"), RefImage = FileUpload.FromPath("ref_image.jpg"), FaceMatchScoreDeclineThreshold = 50.0, RotateImage = false, SaveApiRequest = true, VendorData = "user-123", Metadata = new Dictionary { ["flow"] = "login" }, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- La chiave API della tua applicazione, da Developers -> API keys nella Business Console. La chiave primaria ha accesso completo. Una chiave con nome può avere un ambito definito: nessuno, lettura o scrittura per risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco di indirizzi IP e a una data di scadenza. 401 indica che la chiave è errata, revocata o scaduta; 403 indica che non è stata inviata alcuna chiave, che la chiave non ha accesso a questa risorsa o azione, oppure che la richiesta proviene da un indirizzo non incluso nel suo elenco IP; 404 su una route di sessione indica che la sessione non rientra nei workflow o negli stati previsti dalla chiave. Una chiave senza accesso ai media riceve gli URL di immagini, video e PDF come null, e una chiave senza permessi di scrittura sulle sessioni riceve link e token di sessione come null. Consulta https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.