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

# Caricamento facciale API: liste biometriche

> Carica un'immagine del volto in base64 in una blocklist o allowlist di Didit. Didit estrae il modello biometrico per i confronti futuri.



Prompt dell'API per caricare un volto in una lista
        Copia il prompt negli appunti



      
      

\<pre>

\`Upload a face image directly to a Didit face blocklist or allowlist through the Management API.

Endpoint:
POST https://verification.didit.me/v3/lists/{list_uuid}/entries/face-upload/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: write.

Goal:
\- Add a face to a face blocklist or allowlist when I do not have a verification session to reference. Didit detects the faces in the image, keeps the largest one, stores the image and a crop of that face, computes a biometric face template that new sessions are compared against, and creates the entry.
\- A face blocklist entry declines future sessions whose face matches. A face allowlist entry stops a matching face from triggering the duplicated-face action, but does not override blocklist matches or the other checks.

When NOT to use this:
\- If I am listing a face from an existing verification session, use POST /v3/lists/{list_uuid}/entries/ with reference_session_id instead, so the entry links back to the session.

Path parameter:
\- list_uuid: must be a list with entry_type "face" and list_type "blocklist" or "allowlist". Other lists return 400.

Request body (application/json):
\{
"image": "/9j/4AAQSkZ...",        // required: base64-encoded JPEG or PNG, at most 2 MB once decoded. Do not include a "data:image/..." prefix.
"comment": "Known fraud attempt"  // optional
}

Important constraints:
\- The image must show a clearly visible face. If no face is detected, the API returns 400 and no entry is created. If it shows several faces, Didit uses the largest one.
\- In a sandbox application the image is not analysed or stored: the entry has display_label "Sandbox face entry" and metadata.sandbox true, and matches nothing.

Example call:
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/face-upload/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"image": "/9j/4AAQSkZ...", "comment": "Known fraud attempt"}'

Example response (201):
\{
"uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"value": "44444444-5555-6666-7777-888888888888",
"display_label": "Manually uploaded face",
"comment": "Known fraud attempt",
"added_by": "api",
"reference_session_id": null,
"reference_session_number": null,
"reference_session_type": null,
"reference_object_uuid": "44444444-5555-6666-7777-888888888888",
"metadata": { "reference_image_url": "https://<media-host>/face_reference_image.jpg" },
"created_at": "2026-10-12T10:12:18.904467Z"
}

value and reference_object_uuid are the UUID of the new face. metadata.reference_image_url is a short-lived signed URL (null for a scoped key without media: read).

Failure modes:
\- 400: the list is not a face list ({ "detail": "Face upload is only available for face-type lists." }), the list is a custom face list, image is missing, larger than 2 MB, not valid base64, not a readable JPEG or PNG, or shows no face ({ "image": "No face detected in the image. Please upload a clear photo with a visible face." }).
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows: write.
\- 404: list not found in this application ({ "detail": "List not found." }).
\- 503: face analysis is temporarily unavailable; no entry was created, retry later.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- The face template is added to biometric matching. Future sessions matching a blocklisted face are declined. Future sessions matching an allowlisted face skip the duplicated-face action and include an informational allowlist warning.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Incolla in

Carica un'immagine del volto codificata in base64 in una blocklist o allowlist di volti. Didit rileva i volti nell'immagine, conserva quello più grande, memorizza l'immagine e un ritaglio di quel volto e calcola il modello biometrico facciale rispetto al quale vengono confrontate le nuove sessioni. Il `value` della nuova voce è l'UUID di quel volto.Disponibile solo per le liste con `entry_type: face` e `list_type: blocklist` oppure `list_type: allowlist`.> [!TIP]
>
> Se vuoi inserire un volto in una blocklist o allowlist **a partire da una sessione esistente**, usa [Crea voce](https://docs.didit.me/it/management-api/lists/create-entry.md) con `reference_session_id`: la voce viene collegata alla sessione.> [!WARNING]
>
> L'immagine deve contenere un volto chiaramente visibile e avere una dimensione massima di 2 MB una volta decodificata. Se non viene rilevato alcun volto, la richiesta restituisce `400` e non viene creata alcuna voce. Se l'analisi facciale è temporaneamente non disponibile, restituisce `503`: riprova più tardi.Per rimuovere il volto dalla lista, [elimina la relativa voce](https://docs.didit.me/it/management-api/lists/delete-entry.md): non verrà più confrontato con le nuove sessioni.


## OpenAPI

````yaml it/openapi-25.json POST /v3/lists/{list_uuid}/entries/face-upload/
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/lists/{list_uuid}/entries/face-upload/:
    post:
      tags:
        - Lists
      summary: Carica un volto in un elenco
      description: >-
        Aggiunge un volto a una blocklist o allowlist di volti da un'immagine
        JPEG o PNG con codifica base64, nei casi in cui non si disponga di una
        sessione di verifica a cui fare riferimento. Didit rileva i volti
        nell'immagine, utilizza quello più grande e crea una voce i cui `value`
        e `reference_object_uuid` corrispondono all'UUID del nuovo volto. Un
        volto presente nella blocklist fa rifiutare le nuove sessioni il cui
        volto corrisponde; un volto presente nell'allowlist salta l'azione per
        volto duplicato e non sovrascrive mai una corrispondenza nella
        blocklist. In un'applicazione sandbox l'immagine non viene analizzata e
        la voce non corrisponde a nulla. Una chiave API con ambito limitato
        richiede `workflows: write`. Per inserire in lista un volto da una
        sessione esistente, utilizza invece [Crea una voce
        dell'elenco](https://docs.didit.me/it/management-api/lists/create-entry)
        con `reference_session_id`.
      operationId: upload_list_entry_face
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            UUID di una lista con `entry_type: face` e `list_type: blocklist` o
            `allowlist`.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - image
              properties:
                image:
                  type: string
                  format: byte
                  description: >-
                    JPEG o PNG codificato in Base64, di massimo 2 MB una volta
                    decodificato, che mostra un volto chiaramente visibile.
                    Invia la stringa base64 pura, senza il prefisso
                    `data:image/...;base64,`.
                comment:
                  type: string
                  default: ''
                  description: >-
                    Nota opzionale a testo libero, ad esempio il motivo
                    dell'inserimento in elenco.
            examples:
              Face image:
                value:
                  image: /9j/4AAQSkZJRgABAQAAAQABAAD...
                  comment: Known fraud attempt
      responses:
        '201':
          description: La voce del volto è stata creata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceListEntry'
              examples:
                Uploaded face:
                  value:
                    uuid: cccccccc-dddd-eeee-ffff-000000000000
                    value: 44444444-5555-6666-7777-888888888888
                    display_label: Manually uploaded face
                    comment: Known fraud attempt
                    added_by: api
                    reference_session_id: null
                    reference_session_number: null
                    reference_session_type: null
                    reference_object_uuid: 44444444-5555-6666-7777-888888888888
                    metadata:
                      reference_image_url: >-
                        https://media.example.com/faces/reference.jpg?expires=1760263938&signature=3f9a1c
                    created_at: '2026-10-12T10:12:18.904467Z'
                Sandbox application:
                  value:
                    uuid: cccccccc-dddd-eeee-ffff-000000000000
                    value: 44444444-5555-6666-7777-888888888888
                    display_label: Sandbox face entry
                    comment: Known fraud attempt
                    added_by: api
                    reference_session_id: null
                    reference_session_number: null
                    reference_session_type: null
                    reference_object_uuid: 44444444-5555-6666-7777-888888888888
                    metadata:
                      sandbox: true
                    created_at: '2026-10-12T10:12:18.904467Z'
        '400':
          description: >-
            La lista non accetta caricamenti di volti, oppure l'immagine è
            mancante, non valida, troppo grande o non mostra un volto
            utilizzabile. Nessuna voce è stata creata.
          content:
            application/json:
              examples:
                Not a face list:
                  value:
                    detail: Face upload is only available for face-type lists.
                Custom face list:
                  value:
                    detail: >-
                      Face upload is only available for face blocklists and
                      allowlists.
                Missing image:
                  value:
                    image:
                      - This field is required.
                Invalid base64:
                  value:
                    image:
                      - Invalid base64 encoding.
                Too large:
                  value:
                    image:
                      - Image exceeds maximum size of 2 MB.
                Unreadable image:
                  value:
                    image: Invalid image. Provide a valid base64-encoded JPG or PNG.
                No face:
                  value:
                    image: >-
                      No face detected in the image. Please upload a clear photo
                      with a visible face.
                No usable face:
                  value:
                    image: Could not extract face embedding. Try a different image.
        '401':
          description: >-
            La chiave API con ambito è scaduta. Altri errori di autenticazione
            restituiscono `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            L'intestazione `x-api-key` è mancante (una chiave errata, revocata o
            scaduta riceve `401`), oppure una chiave API con ambito limitato non
            dispone di `workflows: write` o viene utilizzata da un indirizzo IP
            non presente nella sua allowlist.
          content:
            application/json:
              examples:
                Missing or invalid API key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without workflows access:
                  value:
                    detail: This API key has no write access to workflows.
        '404':
          description: >-
            Nessuna lista con questo UUID esiste nell'applicazione della chiave
            API, oppure è stata eliminata.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: List not found.
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
        '503':
          description: >-
            L'analisi facciale è temporaneamente non disponibile. Nessuna voce è
            stata creata; riprova più tardi.
          content:
            application/json:
              examples:
                Unavailable:
                  value:
                    detail: Service temporarily unavailable. Please try again later.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/face-upload/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d "{\"image\": \"$(base64 < face.jpg | tr -d '\n')\", \"comment\": \"Known fraud attempt\"}"
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.lists.entries.upload_face(
                "11111111-2222-3333-4444-555555555555",
                image="/9j/4AAQSkZJRgABAQAAAQABAAD...",
                comment="Known fraud attempt",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.lists.entries.uploadFace("11111111-2222-3333-4444-555555555555",
            {
              image: "/9j/4AAQSkZJRgABAQAAAQABAAD...",
              comment: "Known fraud attempt",
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.UploadFace(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesUploadFaceParams{\n\tImage:   \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n\tComment: didit.String(\"Known fraud attempt\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.ListsEntriesUploadFaceParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.lists().entries().uploadFace("11111111-2222-3333-4444-555555555555",
            ListsEntriesUploadFaceParams.builder()
                    .image("/9j/4AAQSkZJRgABAQAAAQABAAD...")
                    .comment("Known fraud attempt")
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->lists->entries->uploadFace('11111111-2222-3333-4444-555555555555',
            [
                'image' => '/9j/4AAQSkZJRgABAQAAAQABAAD...',
                'comment' => 'Known fraud attempt',
            ]);

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.lists.entries.upload_face(
              "11111111-2222-3333-4444-555555555555",
              image: "/9j/4AAQSkZJRgABAQAAAQABAAD...",
              comment: "Known fraud attempt"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Lists.Entries.UploadFaceAsync("11111111-2222-3333-4444-555555555555",
            new ListsEntriesUploadFaceParams

            {
                Image = "/9j/4AAQSkZJRgABAQAAAQABAAD...",
                Comment = "Known fraud attempt",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    ComplianceListEntry:
      type: object
      description: Un singolo valore in una lista.
      required:
        - uuid
        - value
        - display_label
        - comment
        - added_by
        - reference_session_id
        - reference_session_number
        - reference_session_type
        - reference_object_uuid
        - metadata
        - created_at
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Identificatore della voce. Utilizzalo come `entry_uuid` in Elimina
            una voce dell'elenco.
        value:
          type: string
          description: >-
            Il valore inserito in lista: un numero di telefono in formato E.164,
            un indirizzo email, un numero di documento, un indirizzo IP o un
            intervallo CIDR, un'impronta digitale del dispositivo, un indirizzo
            del wallet, un conto bancario, un codice paese ISO 3166-1 alpha-3,
            un `vendor_data`, qualsiasi stringa su una lista `key`, oppure
            l'UUID del volto memorizzato su una lista di volti. I valori inviati
            vengono memorizzati in minuscolo, ad eccezione dei numeri di
            telefono e dei codici paese. La corrispondenza non fa distinzione
            tra maiuscole e minuscole.
        display_label:
          type: string
          nullable: true
          maxLength: 512
          description: >-
            Etichetta di facile lettura. Didit la compila per le voci estratte
            da una sessione (ad esempio il nome del titolare e il numero del
            documento) quando non ne invii nessuna.
        comment:
          type: string
          description: Nota in formato testo libero. Stringa vuota se non impostata.
        added_by:
          type: string
          nullable: true
          description: >-
            Chi ha aggiunto la voce: `api` (una chiave API), l'indirizzo email
            di un utente della console o `console`, `system` o `migration` (voci
            create da Didit), oppure `rule` (un'azione di una regola di
            transazione o monitoraggio).
        reference_session_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Sessione di verifica da cui è stata estratta la voce. `null` quando
            la voce è stata aggiunta per valore.
        reference_session_number:
          type: integer
          nullable: true
          description: >-
            Numero della sessione con ambito limitato all'applicazione, come
            mostrato nella console.
        reference_session_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - null
          description: >-
            `kyc` per una sessione di verifica di una persona fisica, `kyb` per
            una sessione di verifica aziendale, `null` quando non è presente
            alcuna sessione.
        reference_object_uuid:
          type: string
          format: uuid
          nullable: true
          description: >-
            Il record rappresentato dalla voce: il record del volto, del
            documento, del telefono o dell'email letto da una sessione, il volto
            creato tramite Upload a face to a list, o l'UUID inviato (ad esempio
            l'UUID di una transazione o il `didit_internal_id` di un utente).
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Contesto aggiuntivo. Contiene le chiavi impostate da Didit (elencate
            qui) unite a qualsiasi `metadata` inviato durante la creazione della
            voce, restituite così come memorizzate. `null` se non è presente
            alcuno.
          properties:
            reference_image_url:
              type: string
              description: >-
                Voci del volto: URL firmato di breve durata, emesso nuovamente a
                ogni chiamata; `null` per una chiave API con ambito senza
                `media: read`. Assente quando nessuna immagine appartiene alla
                voce.
            front_image_url:
              type: string
              description: >-
                Voci del documento contenenti l'immagine frontale del documento:
                URL firmato di breve durata, riemesso a ogni chiamata; `null`
                per una chiave API con ambito priva di `media: read`.
            full_name:
              type: string
              description: >-
                Voci del documento estratte da una sessione: nome completo del
                titolare.
            issuing_state:
              type: string
              description: >-
                Voci del documento estratte da una sessione: paese di emissione
                ISO 3166-1 alpha-3.
            document_type:
              type: string
              description: >-
                Voci del documento estratte da una sessione: codice del tipo di
                documento, ad esempio `P`, `ID` o `DL`.
            region:
              type: string
              description: >-
                Voci del documento estratte da una sessione: stato o provincia
                di emissione per un documento emesso a livello regionale, vuoto
                se non applicabile. Non impostato da Aggiungi elementi della
                sessione alla blocklist.
            document_number:
              type: string
              description: >-
                Voci del documento estratte da una sessione: il numero del
                documento.
            face_image_source:
              type: string
              enum:
                - front_image_camera_front
                - back_image_camera_front
              description: >-
                Voci facciali tratte da un selfie acquisito durante
                l'acquisizione del documento: quale selfie. Assente per i volti
                del rilevamento della vitalità.
            reference_node_id:
              type: string
              nullable: true
              description: >-
                Voci facciali tratte da un selfie acquisito durante
                l'acquisizione del documento: il nodo di verifica dell'identità
                da cui proviene il selfie.
            fingerprint_tier:
              type: string
              nullable: true
              enum:
                - persistent_id
                - composite_hash
                - legacy_fp
                - unknown
                - null
              description: >-
                Voci del fingerprint del dispositivo acquisite da una sessione:
                come è stato ricavato il fingerprint. `persistent_id` identifica
                un singolo dispositivo; `composite_hash` e `legacy_fp` possono
                essere condivisi da dispositivi dello stesso modello.
            sandbox:
              type: boolean
              description: >-
                `true` su una voce del volto caricata in un'applicazione
                sandbox; tale voce non produce alcuna corrispondenza.
            reference_type:
              type: string
              enum:
                - transaction
                - vendor_user
                - vendor_business
              description: >-
                Impostato da te: cosa indica `reference_object_uuid`, in modo
                che la console crei un collegamento di ritorno verso di esso.
            reference_id:
              type: string
              description: 'Impostato da te: identificativo del record di origine.'
        created_at:
          type: string
          format: date-time
          description: Data e ora di aggiunta della voce.
  responses:
    RateLimitedWrite:
      description: >-
        Il limite di scrittura condiviso di 300 richieste al minuto per chiave
        API è stato superato. Rispetta `Retry-After` prima di riprovare.
      content:
        application/json:
          schema:
            type: object
            required:
              - detail
            properties:
              detail:
                type: string
          example:
            detail: >-
              Write request rate limit exceeded. You can make up to 300 requests
              per minute.
  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.