Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.uip.digital/llms.txt

Use this file to discover all available pages before exploring further.

Poll this endpoint every 2-3 seconds to check session status. When the user completes biometric verification, the response includes all requested identity data.

​
Response — Pending

{
  "status": "pending",
  "expires_at": "2025-01-11T12:35:00Z"
}

​
Response — Completed

When the user completes biometric verification, all requested data is returned directly: 
{
  "status": "completed",
  "expires_at": "2025-01-11T12:35:00Z",
  "audit_id": "audit_9z8y7x6w5v4u",
  "uip_id": "user_abc123def456",
  "first_name": "John",
  "last_name": "Doe",
  "date_of_birth": "1990-05-15",
  "country": "US",
  "identity_expires_at": "2027-01-11T00:00:00Z"
}

​
Response — Expired

{
  "status": "expired",
  "expires_at": "2025-01-11T12:35:00Z"
}
​
status
string
required
Session status: pending, completed, or expired
​
audit_id
string
Permanent audit trail reference (only present when completed). Save this for compliance.
​
uip_id
string
User’s unique UIP identifier (only present when completed).
​
first_name
string
Verified first name (if requested)
​
last_name
string
Verified last name (if requested)
​
date_of_birth
string
Verified date of birth in YYYY-MM-DD format (if requested)
​
country
string
Verified country code (if requested)
​
identity_expires_at
string
When the user’s identity verification expires
No webhooks needed. The Identify API uses simple polling. No redirect URIs, no code exchange.