Vai al contenuto principale
PATCH
curl

Panoramica

Aggiorna i campi modificabili di un’entità User. I campi propagati dalle sessioni di Verifica dell’identità (KYC) verificate (full_name, date_of_birth, portrait_image, contatori aggregati, features) sono di sola lettura.

Quando usarlo

  • Aggiorna i metadati del tuo utente — sposta un utente a un altro livello, modifica i tag, registra una nota interna.
  • Rinomina — imposta un display_name più chiaro per le viste interne della console.
  • Sovrascrivi i dati verificati (con cautela) — le sovrascritture manuali sono consentite, ma vengono registrate nel registro di audit.

Note

  • vendor_data nell’URL non può essere modificato tramite questo endpoint. Se devi cambiare la chiave, crea un nuovo utente ed elimina quello vecchio.
  • Emette un webhook user.data.updated con un array changed_fields, così i consumer possono sincronizzare i dati in modo efficiente.
  • Una modifica di status tramite questo endpoint funziona come Aggiorna lo stato dell’utente. Viene registrata nelle attività della persona, con il campo facoltativo reason (fino a 1000 caratteri) come commento, e BLOCKED aggiunge vendor_data alla blocklist di sistema. Il webhook user.status.updated non include reason.
  • Se esegui una PATCH su un campo attualmente gestito da una sessione verificata, la sovrascrittura viene accettata ma segnalata nel registro di audit.

Autorizzazioni

Il segreto primario e le chiavi API con accesso completo possono sempre chiamare questo endpoint. Una chiave con accesso personalizzato richiede l’autorizzazione di scrittura su Persone (users). Una chiave limitata ad alcuni workflow o a sessioni approvate non può accedere a questo endpoint. I ruoli e le autorizzazioni della Console determinano cosa può fare un membro del team nella Console. Non vengono valutati per le richieste con chiave API.

Correlati

Autorizzazioni

x-api-key
string
header
obbligatorio

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.

Parametri del percorso

vendor_data
string
obbligatorio

Il tuo identificatore univoco per l'utente (stringa a formato libero, NON un UUID).

Corpo

application/json
full_name
string | null

Nome completo dell'utente

Maximum string length: 512
display_name
string | null

Nome visualizzato personalizzato per questo utente

date_of_birth
string<date> | null

Data di nascita nel formato YYYY-MM-DD

status
enum<string>

Stato del ciclo di vita dell'utente. Una modifica viene registrata come attività STATUS_CHANGED, e BLOCKED aggiunge il vendor_data alla blocklist di sistema (passando a uno stato diverso da BLOCKED la voce viene rimossa).

Opzioni disponibili:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Oggetto JSON arbitrario da allegare all'utente. Sostituisce completamente i metadati esistenti in caso di aggiornamento: esegui l'unione lato client se desideri solo aggiungere chiavi.

approved_emails
string[]

Indirizzi email verificati per questo utente, ad es. ["john@example.com"]. Sostituisce completamente l'elenco memorizzato.

approved_phones
string[]

Numeri di telefono verificati per questo utente. Sostituisce completamente l'elenco memorizzato.

issuing_states
string[]

Paesi di emissione (ISO 3166-1 alpha-3), ad es. ["USA"]. Sostituisce completamente l'elenco memorizzato.

reason
string | null

Il motivo per cui lo stato è cambiato. Registrato nella voce di cambio di stato dell'attività dell'utente (comments[].comment e Activity nella Business Console), solo quando lo stato cambia effettivamente. I webhook non lo includono.

Maximum string length: 1000

Risposta

Utente aggiornato. Viene restituito il record utente aggiornato completo (stessa struttura di Get User).

Dettaglio completo dell'utente. Estende UserListItem con metadati, commenti e updated_at.

didit_internal_id
string<uuid>

UUID interno stabile di Didit per questo utente.

vendor_data
string | null

Il tuo identificatore univoco per questo utente (passato durante la creazione delle sessioni). Può essere null se non è stato fornito alcun identificatore del fornitore.

display_name
string | null

Nome visualizzato personalizzato impostato da te

full_name
string | null

Nome completo estratto dai documenti verificati

date_of_birth
string<date> | null
effective_name
string | null

Miglior nome disponibile: display_name se impostato, altrimenti full_name

status
enum<string>

Stato del ciclo di vita del record utente (NON uno stato della sessione). ACTIVE è il valore predefinito, FLAGGED contrassegna l'utente per una verifica manuale, BLOCKED impedisce nuove sessioni per questo vendor_data.

Opzioni disponibili:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

URL prefirmato della foto ritratto dell'utente (scade dopo alcune ore)

session_count
integer

Numero totale di sessioni di verifica per questo utente

approved_count
integer

Numero di sessioni approvate

declined_count
integer

Numero di sessioni rifiutate

in_review_count
integer

Numero di sessioni in revisione

issuing_states
string[]

Codici ISO 3166-1 alpha-3 dei paesi di emissione rilevati nei documenti d'identità approvati di questo utente, ad es. ["USA", "ESP"]. Array vuoto se assenti.

approved_emails
string[]

Indirizzi email verificati raccolti dalle sessioni approvate di questo utente, ad es. ["john@example.com"].

approved_phones
string[]

Numeri di telefono verificati raccolti dalle sessioni approvate di questo utente, ad es. ["+14155551234"].

features
object

Stato aggregato per funzionalità in tutte le sessioni di questo utente. Chiavi possibili: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Valori possibili: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Gli stessi dati di features, sotto forma di array ordinato di oggetti {feature, status}.

last_session_at
string<date-time> | null

Timestamp della sessione più recente

first_session_at
string<date-time> | null

Timestamp della prima sessione

last_activity_at
string<date-time> | null

Timestamp dell'attività più recente su questo utente (sessione, transazione, cambio di stato, modifica dei dati, ecc.).

tags
object[]

Assegnazioni dei tag. NOTA: nelle risposte di dettaglio ogni voce è un oggetto collegamento del tag ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), a differenza della struttura piatta {uuid, name, color} usata nelle risposte di elenco.

created_at
string<date-time>
metadata
object

JSON di metadati personalizzati che hai allegato a questo utente. Il valore predefinito è {}.

comments
object[]

Registro delle attività e commenti per questo utente (modifiche di stato, modifiche al profilo, note manuali).

updated_at
string<date-time>
Ultima modifica il 7 novembre 2026