Skip to main content
GET
/
v3
/
users
/
{vendor_data}
Get User
curl --request GET \
  --url https://verification.didit.me/v3/users/{vendor_data}/ \
  --header 'x-api-key: <api-key>'
{
  "vendor_data": "user-abc-123",
  "display_name": null,
  "full_name": "John Michael Doe",
  "date_of_birth": "1990-05-15",
  "effective_name": "John Michael Doe",
  "status": "Approved",
  "portrait_image_url": "https://service-didit-verification.s3.amazonaws.com/...",
  "session_count": 3,
  "approved_count": 2,
  "declined_count": 0,
  "in_review_count": 1,
  "issuing_states": {
    "USA": 2
  },
  "approved_emails": {
    "john@example.com": true
  },
  "approved_phones": {
    "+14155551234": true
  },
  "features": {
    "OCR": "Approved",
    "LIVENESS": "Approved",
    "FACE_MATCH": "Approved",
    "AML": "Approved"
  },
  "features_list": [
    {
      "feature": "OCR",
      "status": "Approved"
    },
    {
      "feature": "LIVENESS",
      "status": "Approved"
    },
    {
      "feature": "FACE_MATCH",
      "status": "Approved"
    },
    {
      "feature": "AML",
      "status": "Approved"
    }
  ],
  "last_session_at": "2025-06-15T10:30:00Z",
  "first_session_at": "2025-06-01T08:00:00Z",
  "tags": [
    {
      "uuid": "t1111111-2222-3333-4444-555555555555",
      "name": "VIP",
      "color": "#2567FF"
    }
  ],
  "created_at": "2025-06-01T08:00:00Z",
  "metadata": {
    "tier": "premium",
    "source": "website"
  },
  "comments": [
    {
      "uuid": "c1111111-2222-3333-4444-555555555555",
      "comment_type": "status_change",
      "comment": "Auto-approved after AML clear",
      "actor_email": null,
      "actor_name": "System",
      "previous_status": "In Review",
      "new_status": "Approved",
      "created_at": "2025-06-01T10:30:00Z"
    }
  ],
  "updated_at": "2025-06-15T10:30:00Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

vendor_data
string
required

Your unique identifier for the user (the vendor_data you passed when creating sessions).

Response

Full user detail including metadata, comments/activity log, and all session data.

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

vendor_data
string

Your unique identifier for this user (passed when creating sessions)

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

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

tags
object[]

Tags assigned to this user

created_at
string<date-time>
metadata
object

Custom metadata JSON you attached to this user

comments
object[]

Activity log and comments for this user

updated_at
string<date-time>