Update User - Didit Documentation

curl

curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"display_name": "Jane S.", "status": "FLAGGED"}'

{
  "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
  "vendor_data": "user-abc-123",
  "display_name": "Jane S.",
  "full_name": "Jane Elizabeth Smith",
  "date_of_birth": "1985-11-22",
  "effective_name": "Jane S.",
  "status": "FLAGGED",
  "metadata": {
    "tier": "premium"
  },
  "updated_at": "2025-06-15T10:30:00Z"
}

PATCH

users

{vendor_data}

curl

curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"display_name": "Jane S.", "status": "FLAGGED"}'

{
  "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
  "vendor_data": "user-abc-123",
  "display_name": "Jane S.",
  "full_name": "Jane Elizabeth Smith",
  "date_of_birth": "1985-11-22",
  "effective_name": "Jane S.",
  "status": "FLAGGED",
  "metadata": {
    "tier": "premium"
  },
  "updated_at": "2025-06-15T10:30:00Z"
}

Overview

Updates mutable fields on a User entity. Fields propagated from verified User Verification (KYC) sessions (full_name, date_of_birth, portrait_image, aggregate counters, features) are read-only.

When to use it

Update your own metadata — move a user between tiers, change tags, record an internal note.
Rename — set a better display_name for internal-facing console views.
Override verified data (with caution) — manual overrides are allowed but logged to the audit trail.

Notes

vendor_data in the URL cannot be changed via this endpoint. Create a new user and delete the old one if you need to rekey.
Emits a user.data.updated webhook with a changed_fields array so consumers can sync efficiently.
If you PATCH a field that is currently managed by a verified session, the override will be accepted but flagged in the audit log.

Permissions

Role must grant update:users.

Authorizations

x-api-key

string

header

required

Path Parameters

vendor_data

string

required

Your unique identifier for the user (free-form string, NOT a UUID).

Body

application/json

full_name

string | null

Full name of the user

Maximum string length: 512

display_name

string | null

Custom display name for this user

date_of_birth

string<date> | null

Date of birth in YYYY-MM-DD format

status

enum<string>

User lifecycle status. Setting BLOCKED automatically adds the vendor_data to the system blocklist; flipping away from BLOCKED removes that blocklist entry.

Available options:

ACTIVE,

FLAGGED,

BLOCKED

metadata

object

Arbitrary JSON object you attach to the user. Fully replaces the existing metadata on update — merge client-side if you only want to add keys.

approved_emails

object

Map of {email -> true} flagging the verified contact emails for this user.

Show child attributes

approved_phones

object

Map of {phone -> true} flagging the verified phone numbers for this user.

Show child attributes

issuing_states

object

Map of ISO 3166-1 alpha-3 country codes to count of approved documents from that issuer (e.g. {"USA": 2}).

Show child attributes

Response

User updated. The full updated user record (same shape as Get User) is returned.

Full user detail. Extends UserListItem with metadata, comments, and updated_at.

didit_internal_id

string<uuid>

Didit's stable internal UUID for this user.

vendor_data

string | null

Your unique identifier for this user (passed when creating sessions). This can be null when no vendor identifier was supplied.

display_name

string | null

Custom display name set by you

full_name

string | null

Full name extracted from verified documents

date_of_birth

string<date> | null

effective_name

string | null

Best available name: display_name if set, otherwise full_name

status

enum<string>

Overall verification status of this user

Available options:

Approved,

Declined,

In Review,

Pending

portrait_image_url

string | null

Presigned URL of the user's portrait photo (expires after a few hours)

session_count

integer

Total number of verification sessions for this user

approved_count

integer

Number of approved sessions

declined_count

integer

Number of declined sessions

in_review_count

integer

Number of sessions in review

issuing_states

object

Map of ISO3 country codes from approved documents, e.g. {"USA": 2, "ESP": 1}

approved_emails

object

Verified email addresses, e.g. {"john@example.com": true}

approved_phones

object

Verified phone numbers

features

object

Map of feature name to latest status, e.g. {"OCR": "Approved", "LIVENESS": "Approved", "AML": "In Review"}

features_list

object[]

Same as features but as an array of {feature, status} objects

Show child attributes

last_session_at

string<date-time> | null

Timestamp of the most recent session

first_session_at

string<date-time> | null

Timestamp of the first session

​Overview

​When to use it

​Notes

​Permissions

​Related

Authorizations

Path Parameters

Body

Response

Overview

When to use it

Notes

Permissions

Related