Identify API
Authenticate users and retrieve verified identity information with UIP's core identification endpoint.
Overview
The Identify API authenticates users through their UIP identity and returns verified personal information. Users always see exactly what data you're requesting and can choose to approve or deny the request.
Biometric Security
Authentication with verified identity data
QR Code Ready
Automatic generation for desktop flows
Granular Control
Request only the data you need
Real-time Webhooks
Instant authentication notifications
Endpoint
https://identify.api.uip.id/v1/identifyHeaders
Authorization: Bearer YOUR_API_KEY
Content-Type: application/jsonPricing
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| webhook_url | string | Required | URL to receive authentication results |
| requested_data | array | Optional | Specific data fields to request. If empty, requests all available data |
Available Data Fields
Control exactly what information you receive. Users will see your business name and the data you're requesting.
Standard Data Fields
full_name User's complete legal name as verified during identity verification
date_of_birth User's date of birth in YYYY-MM-DD format
country_of_origin Country where identity was verified (ISO 3166-1 alpha-2)
Enterprise/Government Only
personal_number Government-issued personal identification number (SSN, National ID, etc.)
⚠️ Restricted Access: Only available to verified enterprise and government accounts
Privacy Best Practice
Only request the data you actually need. All responses always include the user's uip_id.
Request Examples
Request All Available Data
{ "webhook_url": "https://myapp.com/webhooks/uip", "requested_data": [] }
Request Specific Fields
{ "webhook_url": "https://myapp.com/webhooks/uip", "requested_data": ["full_name", "date_of_birth"] }
Webhook Response
{ "event": "authentication_completed", "session_id": "sess_1234567890abcdef", "status": "success", "user_data": { "uip_id": "uip_user_9876543210", "full_name": "Alice Johnson", "date_of_birth": "1990-05-15", "verified": true }, "timestamp": "2024-01-15T10:30:00Z" }
Webhook Security
Always verify webhook authenticity using the signature header before processing the data.