> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# Get User
> Fetch one [user](/entities/users) by `vendor_data` (exact match). Adds `metadata`, `comments`, and `updated_at` to the list view, and switches `tags` to the detailed tag-link shape. Returns soft-deleted users too.
export const AgentPromptAccordion = ({prompt, title = "AI Agent Integration Prompt"}) => {
const [copied, setCopied] = React.useState(false);
const handleCopy = e => {
e.stopPropagation();
if (!prompt) return;
navigator.clipboard.writeText(prompt.trim()).then(() => {
setCopied(true);
setTimeout(() => setCopied(false), 2000);
});
};
const agents = ["Claude Code", "Codex", "Cursor", "Devin", "Windsurf", "GitHub Copilot"];
return
{}
{title}
{}
{prompt.trim()}
{}
Paste into
{agents.map(name => {name})}
;
};
Path param:
- vendor_data (string, REQUIRED) — your unique identifier. Free-form string, NOT a UUID. Matching is case-insensitive after Didit normalisation. URL-encode it.
curl:
curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \\
-H 'x-api-key: YOUR_API_KEY'
Response 200 (UserDetailItem) — extends the list shape with metadata, comments (activity log), and updated_at. Key fields:
- didit_internal_id (UUID — Didit's stable internal identifier)
- vendor_data (string)
- display_name, full_name, date_of_birth, effective_name, portrait_image_url
- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices)
- session_count, approved_count, declined_count, in_review_count (aggregate counters)
- features (map of feature -> latest status)
- approved_emails, approved_phones, issuing_states
- metadata (arbitrary JSON you attached)
- comments (chronological activity log: status changes, manual notes, system events)
- created_at, updated_at
See /reference/data-models for the full schema.
Notes:
- Returns the user even if soft-deleted (queries full table) — check fields like deleted_at if you need to filter.
- Aggregate counters update in real time as sessions reach terminal status.
- For bulk lookups, prefer paging GET /v3/users/ and indexing locally on vendor_data instead of fanning out one call per identifier.
Failure modes (envelope {"detail": "..."}):
- 401 — missing or invalid x-api-key.
- 403 — key lacks read:users for this app.
- 404 — no user with that vendor_data in this application.
- 429 — rate-limited.
For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`}
/>
## Overview
Returns a single [User entity](/entities/users/overview) keyed by `vendor_data`. Responses include `didit_internal_id` — Didit's stable internal identifier.
## When to use it
* **Lookup** a user's current verification state — the `features` map gives you the latest status of every feature in a single object.
* **Detail views** in your own UI — pull the profile on demand before rendering.
* **Risk scoring** — combine session counters and `features` to score each user on your side.
## Notes
* `vendor_data` in the URL is case-sensitive.
* Returns `404` if no user with that `vendor_data` exists in the application.
* Aggregate counters (`session_count`, `approved_count`, `declined_count`, `in_review_count`) update in real time as sessions complete.
* See the [User data model](/entities/users/data-model) for every field.
## Permissions
Role must grant `read:users`.
## Related
* [Users overview](/entities/users/overview)
* [Data model](/entities/users/data-model)
* [List users](/management-api/users/list)
## OpenAPI
````yaml GET /v3/users/{vendor_data}/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: Identity verification API. Authenticate with x-api-key header.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/users/{vendor_data}/:
get:
tags:
- Users
summary: Get user
description: >-
Fetch one [user](/entities/users) by `vendor_data` (exact match). Adds
`metadata`, `comments`, and `updated_at` to the list view, and switches
`tags` to the detailed tag-link shape. Returns soft-deleted users too.
operationId: get_user
parameters:
- name: vendor_data
in: path
required: true
schema:
type: string
description: >-
Your unique identifier for the user — a free-form string (NOT a
UUID). This is the same value you passed as `vendor_data` when
creating the session that first introduced this user, matched
exactly as sent.
example: user-abc-123
responses:
'200':
description: >-
Full user detail including metadata, comments/activity log, and
aggregated session data.
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailItem'
examples:
Active user:
value:
didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418
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: ACTIVE
metadata:
tier: premium
source: website
portrait_image_url: https:///...
session_count: 3
approved_count: 2
declined_count: 0
in_review_count: 1
issuing_states:
- USA
approved_emails:
- john@example.com
approved_phones:
- '+14155551234'
features:
ID_VERIFICATION: Approved
LIVENESS: Approved
FACE_MATCH: Approved
AML: Approved
features_list:
- feature: ID_VERIFICATION
status: Approved
- feature: LIVENESS
status: Approved
- feature: FACE_MATCH
status: Approved
- feature: AML
status: Approved
last_session_at: '2025-06-15T10:30:00Z'
last_activity_at: '2025-06-15T10:30:00Z'
first_session_at: '2025-06-01T08:00:00Z'
tags:
- uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d
tag:
uuid: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b
name: VIP
color: '#2567FF'
description: null
source: custom
created_at: '2025-05-01T09:00:00Z'
updated_at: '2025-05-01T09:00:00Z'
added_by_email: analyst@acme.com
added_by_name: Jane Analyst
created_at: '2025-06-02T11:00:00Z'
comments:
- uuid: c1111111-2222-4333-8444-555555555555
comment_type: STATUS_CHANGED
comment: null
actor_email: analyst@acme.com
actor_name: Jane Analyst
previous_status: FLAGGED
new_status: ACTIVE
previous_value: null
new_value: null
changed_fields: []
metadata: null
mentioned_emails: []
created_at: '2025-06-01T10:30:00Z'
created_at: '2025-06-01T08:00:00Z'
updated_at: '2025-06-15T10:30:00Z'
'401':
description: >-
No credentials supplied. Requests to `/v3/users/*` paths without an
`x-api-key` header (or `Authorization: Bearer` token) are rejected
by the authentication middleware before reaching the API.
content:
application/json:
examples:
Missing credentials:
value:
detail: >-
You must be authenticated with a valid access token to
access this endpoint.
'403':
description: >-
Invalid or revoked API key, or the key cannot read this
application's users. Note: on this endpoint an *invalid* key returns
`403` (not `401`).
content:
application/json:
examples:
Forbidden:
value:
detail: You do not have permission to perform this action.
'404':
description: No user with the supplied `vendor_data` exists for this application.
content:
application/json:
examples:
Not found:
value:
detail: Not found.
'429':
description: >-
Rate limit exceeded; back off and retry after the interval indicated
in `Retry-After`.
content:
application/json:
examples:
Rate limited:
value:
detail: Request was throttled. Expected available in 30 seconds.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: |-
curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY'
- lang: python
label: Python
source: >-
import requests
resp = requests.get(
'https://verification.didit.me/v3/users/user-abc-123/',
headers={'x-api-key': 'YOUR_API_KEY'},
)
resp.raise_for_status()
user = resp.json()
print(user['didit_internal_id'], user['status'],
user['session_count'])
- lang: javascript
label: JavaScript
source: |-
const vendorData = encodeURIComponent('user-abc-123');
const user = await fetch(
`https://verification.didit.me/v3/users/${vendorData}/`,
{ headers: { 'x-api-key': process.env.DIDIT_API_KEY } },
).then((r) => r.json());
console.log(user.didit_internal_id, user.status);
components:
schemas:
UserDetailItem:
type: object
description: >-
Full user detail. Extends UserListItem with metadata, comments, and
updated_at.
allOf:
- $ref: '#/components/schemas/UserListItem'
- type: object
properties:
metadata:
type: object
description: >-
Custom metadata JSON you attached to this user. Defaults to
`{}`.
tags:
type: array
description: >-
Tag assignments. NOTE: on detail responses each entry is a tag
*link* object (`{uuid, tag: {...}, added_by_email,
added_by_name, created_at}`), unlike the flat `{uuid, name,
color}` shape used on list responses.
items:
type: object
properties:
uuid:
type: string
format: uuid
description: UUID of the tag assignment (not the tag itself).
tag:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description:
type: string
nullable: true
source:
type: string
enum:
- didit
- custom
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
added_by_email:
type: string
nullable: true
added_by_name:
type: string
nullable: true
created_at:
type: string
format: date-time
comments:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
comment_type:
type: string
enum:
- COMMENT
- STATUS_CHANGED
- METADATA_UPDATED
- TAG_ADDED
- TAG_REMOVED
- PROFILE_UPDATED
comment:
type: string
nullable: true
actor_email:
type: string
nullable: true
actor_name:
type: string
nullable: true
previous_status:
type: string
nullable: true
enum:
- ACTIVE
- FLAGGED
- BLOCKED
- null
new_status:
type: string
nullable: true
enum:
- ACTIVE
- FLAGGED
- BLOCKED
- null
previous_value:
type: object
nullable: true
description: Previous field values for PROFILE_UPDATED entries.
new_value:
type: object
nullable: true
description: New field values for PROFILE_UPDATED entries.
changed_fields:
type: array
items:
type: string
description: Names of the fields changed by a PROFILE_UPDATED entry.
metadata:
type: object
nullable: true
mentioned_emails:
type: array
items:
type: string
created_at:
type: string
format: date-time
description: >-
Activity log and comments for this user (status changes, profile
edits, manual notes).
updated_at:
type: string
format: date-time
UserListItem:
type: object
description: A verified user.
properties:
didit_internal_id:
type: string
format: uuid
description: Didit's stable internal UUID for this user.
vendor_data:
type: string
nullable: true
description: >-
Your unique identifier for this user (passed when creating
sessions). This can be null when no vendor identifier was supplied.
display_name:
type: string
nullable: true
description: Custom display name set by you
full_name:
type: string
nullable: true
description: Full name extracted from verified documents
date_of_birth:
type: string
format: date
nullable: true
effective_name:
type: string
nullable: true
description: 'Best available name: display_name if set, otherwise full_name'
status:
type: string
enum:
- ACTIVE
- FLAGGED
- BLOCKED
description: >-
Lifecycle status of the user record (NOT a session status). `ACTIVE`
is the default, `FLAGGED` marks the user for manual attention,
`BLOCKED` prevents new sessions for this `vendor_data`.
portrait_image_url:
type: string
nullable: true
description: >-
Presigned URL of the user's portrait photo (expires after a few
hours)
session_count:
type: integer
description: Total number of verification sessions for this user
approved_count:
type: integer
description: Number of approved sessions
declined_count:
type: integer
description: Number of declined sessions
in_review_count:
type: integer
description: Number of sessions in review
issuing_states:
type: array
items:
type: string
description: >-
ISO 3166-1 alpha-3 codes of issuing countries seen on this user's
approved ID documents, e.g. `["USA", "ESP"]`. Empty array when none.
approved_emails:
type: array
items:
type: string
description: >-
Verified email addresses collected from this user's approved
sessions, e.g. `["john@example.com"]`.
approved_phones:
type: array
items:
type: string
description: >-
Verified phone numbers collected from this user's approved sessions,
e.g. `["+14155551234"]`.
features:
type: object
description: >-
Aggregated per-feature status across all of this user's sessions.
Possible keys: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`,
`POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`,
`IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Possible
values: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub
Requested`.
features_list:
type: array
items:
type: object
properties:
feature:
type: string
status:
type: string
description: >-
Same data as `features`, as an ordered array of `{feature, status}`
objects.
last_session_at:
type: string
format: date-time
nullable: true
description: Timestamp of the most recent session
first_session_at:
type: string
format: date-time
nullable: true
description: Timestamp of the first session
last_activity_at:
type: string
format: date-time
nullable: true
description: >-
Timestamp of the most recent activity on this user (session,
transaction, status change, data edit, etc.).
tags:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description: Tags assigned to this user
created_at:
type: string
format: date-time
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
````