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 signature, the response includes the audit trail reference.

​
Response — Pending

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

​
Response — Completed

When the user completes biometric signature: 
{
  "status": "completed",
  "expires_at": "2025-01-11T12:35:00Z",
  "audit_id": "audit_9z8y7x6w5v4u",
  "uip_id": "user_abc123def456"
}

​
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).
Save the audit_id: This is your permanent proof of signature. Store it in your database for compliance and verification purposes.
No webhooks needed. The Sign API uses simple polling. No redirect URIs, no code exchange.