Update User Status - Didit Documentation

curl

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

{
  "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
  "vendor_data": "user-abc-123",
  "status": "BLOCKED",
  "updated_at": "2025-06-15T10:30:00Z"
}

PATCH

users

{vendor_data}

update-status

curl

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

{
  "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
  "vendor_data": "user-abc-123",
  "status": "BLOCKED",
  "updated_at": "2025-06-15T10:30:00Z"
}

Overview

Moves a User entity between ACTIVE, FLAGGED, and BLOCKED. See entity lifecycle for the full state machine.

When to use it

Block a user after confirming fraud or a compliance breach.
Flag a user pending manual review without hard-blocking them.
Unblock a user after successful remediation.
Propagate external signals — e.g. when your own fraud engine scores a user above a threshold, move them to FLAGGED via this endpoint.

Notes

Valid values: ACTIVE, FLAGGED, BLOCKED. Invalid values return 400.
Passing a reason string is recommended — it is persisted and surfaced in the audit log and webhook payload.
BLOCKED users have all new sessions auto-declined and all new transactions auto-declined.
Emits a user.status.updated webhook with previous_status, status, and reason.

Enforcement

Status	Effect on new sessions	Effect on new transactions
`ACTIVE`	Normal flow	Normal flow
`FLAGGED`	Permitted but routed to `IN_REVIEW`	Permitted; may auto-escalate depending on rules
`BLOCKED`	Auto-declined	Auto-declined

Permissions

Role must grant update-status:users.

Authorizations

x-api-key

string

header

required

Path Parameters

vendor_data

string

required

Your unique identifier for the user.

Body

application/json

status

enum<string>

required

New lifecycle status. BLOCKED also adds the vendor_data to the system blocklist.

Available options:

ACTIVE,

FLAGGED,

BLOCKED

Response

User status updated. Full user record 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

​Enforcement

​Permissions

​Related

Authorizations

Path Parameters

Body

Response

Overview

When to use it

Notes

Enforcement

Permissions

Related