Saltar al contingut principal
PATCH
curl

Visió general

Actualitza els camps mutables d’una entitat User. Els camps propagats des de sessions de Verificació d’usuaris (KYC) verificades (full_name, date_of_birth, portrait_image, els comptadors agregats i features) són de només lectura.

Quan utilitzar-lo

  • Actualitza les teves metadades: mou un usuari entre nivells, canvia les etiquetes o registra una nota interna.
  • Canvia el nom: defineix un display_name més adequat per a les vistes de la consola d’ús intern.
  • Sobreescriu dades verificades (amb precaució): les sobreescriptures manuals estan permeses, però es registren al registre d’auditoria.

Notes

  • No es pot canviar vendor_data a l’URL amb aquest endpoint. Si cal canviar la clau, crea un usuari nou i elimina l’antic.
  • Emet un webhook user.data.updated amb una matriu changed_fields perquè els consumidors es puguin sincronitzar de manera eficient.
  • Un canvi d’status aquí funciona com Actualitza l’estat de l’usuari. Es registra a l’activitat de la persona, amb el reason opcional (fins a 1000 caràcters) com a comentari, i BLOCKED afegeix el vendor_data a la llista de bloqueig del sistema. El webhook user.status.updated no inclou reason.
  • Si fas un PATCH d’un camp que actualment gestiona una sessió verificada, la sobreescriptura s’accepta però es marca al registre d’auditoria.

Permisos

El secret principal i les claus d’API amb accés complet sempre poden cridar aquest endpoint. Una clau amb accés personalitzat necessita permís d’escriptura sobre Persones (users). Una clau limitada a alguns fluxos de treball o a sessions aprovades no pot accedir a aquest endpoint. Els rols i permisos de la Consola determinen què pot fer un membre de l’equip a la Consola. No s’avaluen per a les sol·licituds amb claus d’API.

Relacionat

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.

Paràmetres de ruta

vendor_data
string
requerit

El teu identificador únic per a l'usuari (cadena de text lliure, NO un UUID).

Cos

application/json
full_name
string | null

Nom complet de l'usuari

Maximum string length: 512
display_name
string | null

Nom visible personalitzat per a aquest usuari

date_of_birth
string<date> | null

Data de naixement en format YYYY-MM-DD

status
enum<string>

Estat del cicle de vida de l'usuari. Un canvi es registra com una activitat STATUS_CHANGED, i BLOCKED afegeix el vendor_data a la llista de bloqueig del sistema (sortir de BLOCKED elimina aquesta entrada).

Opcions disponibles:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Objecte JSON arbitrari que adjuntes a l'usuari. Substitueix completament les metadades existents en actualitzar; fusiona-les al costat del client si només vols afegir claus.

approved_emails
string[]

Adreces de correu electrònic verificades per a aquest usuari, p. ex. ["john@example.com"]. Substitueix completament la llista emmagatzemada.

approved_phones
string[]

Números de telèfon verificats per a aquest usuari. Substitueix completament la llista emmagatzemada.

issuing_states
string[]

Països emissors (ISO 3166-1 alfa-3), p. ex. ["USA"]. Substitueix completament la llista emmagatzemada.

reason
string | null

Per què ha canviat l'estat. Es registra a l'entrada de canvi d'estat de l'activitat de l'usuari (comments[].comment, i Activitat a la Business Console), només quan l'estat canvia realment. Els webhooks no l'inclouen.

Maximum string length: 1000

Resposta

Usuari actualitzat. Es retorna el registre d'usuari complet actualitzat (amb la mateixa estructura que a Get User).

Detall complet de l'usuari. Amplia UserListItem amb metadades, comentaris i updated_at.

didit_internal_id
string<uuid>

UUID intern estable de Didit per a aquest usuari.

vendor_data
string | null

El teu identificador únic per a aquest usuari (passat en crear sessions). Pot ser nul quan no s'ha proporcionat cap identificador de proveïdor.

display_name
string | null

Nom visible personalitzat definit per tu

full_name
string | null

Nom complet extret dels documents verificats

date_of_birth
string<date> | null
effective_name
string | null

Millor nom disponible: display_name si està definit, en cas contrari full_name

status
enum<string>

Estat del cicle de vida del registre d'usuari (NO és un estat de la sessió). ACTIVE és el valor per defecte, FLAGGED marca l'usuari per a atenció manual, BLOCKED impedeix noves sessions per a aquest vendor_data.

Opcions disponibles:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

URL presignada de la foto de retrat de l'usuari (caduca al cap d'unes hores)

session_count
integer

Nombre total de sessions de verificació per a aquest usuari

approved_count
integer

Nombre de sessions aprovades

declined_count
integer

Nombre de sessions rebutjades

in_review_count
integer

Nombre de sessions en revisió

issuing_states
string[]

Codis ISO 3166-1 alpha-3 dels països emissors que consten als documents d'identitat aprovats d'aquest usuari, p. ex. ["USA", "ESP"]. Matriu buida si no n'hi ha cap.

approved_emails
string[]

Adreces de correu electrònic verificades recollides de les sessions aprovades d'aquest usuari, p. ex. ["john@example.com"].

approved_phones
string[]

Números de telèfon verificats recollits de les sessions aprovades d'aquest usuari, p. ex. ["+14155551234"].

features
object

Estat agregat per funcionalitat a totes les sessions d'aquest usuari. Claus possibles: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Valors possibles: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Les mateixes dades que features, com una llista ordenada d'objectes {feature, status}.

last_session_at
string<date-time> | null

Marca de temps de la sessió més recent

first_session_at
string<date-time> | null

Marca de temps de la primera sessió

last_activity_at
string<date-time> | null

Marca de temps de l'activitat més recent d'aquest usuari (sessió, transacció, canvi d'estat, edició de dades, etc.).

tags
object[]

Assignacions d'etiquetes. NOTA: a les respostes de detall cada entrada és un objecte d'enllaç d'etiqueta ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), a diferència de l'estructura plana {uuid, name, color} utilitzada a les respostes de llista.

created_at
string<date-time>
metadata
object

JSON de metadades personalitzades que has adjuntat a aquest usuari. Per defecte és {}.

comments
object[]

Registre d'activitat i comentaris per a aquest usuari (canvis d'estat, edicions de perfil, notes manuals).

updated_at
string<date-time>
Darrera modificació el 7 de novembre del 2026