Our REST API provides endpoints for generating verification tokens and retrieving verification results.
Request
{
"metadata": {
"user_id": "user-123",
"reference": "order-456"
},
"callback_url": "https://your-api.example.com/webhook",
"success_url": "https://your-app.example.com/success",
"error_url": "https://your-app.example.com/error"
}Response
{
"process_token": "tok_v1_7f4b5e3a2c1d9f8e7d6c5b4a3f2e1d",
"expires_at": "2023-12-31T23:59:59Z"
}Headers
Header
Description
Your API key from the OkID dashboard
application/json
Response
{
"id": "ver_6a7b8c9d0e1f2g3h4i5j",
"status": "completed",
"created_at": "2023-12-30T10:15:30Z",
"completed_at": "2023-12-30T10:17:45Z",
"document_type": "passport",
"verification_details": {
"first_name": "John",
"last_name": "Doe",
"document_number": "X123456",
"expiry_date": "2028-05-20",
"date_of_birth": "1990-01-15"
},
"metadata": {
"user_id": "user-123",
"reference": "order-456"
}
}Headers
Header
Description
Your API key from the OkID dashboard
<script src="https://cdn.okid.io/sdk/okid.js"></script>// Initialize the verification with the process token
const config = {
apiUrl: 'https://api1.okid.io',
frontendUrl: 'https://verify.okid.io',
processToken: 'tok_v1_7f4b5e3a2c1d9f8e7d6c5b4a3f2e1d',
flowName: 'standard',
locale: 'en',
onComplete: (data) => {
console.log('Verification completed:', data);
},
onError: (error) => {
console.error('Verification error:', error);
}
};
// Create okID instance
const okID= new okID(config);
// Start the verification process
okID.init();Description
|
Frontend URL (default: https://verify.okid.io)
Verification token generated from the API
Verification flow type (default: standard)
Interface language (default: en)
Callback when verification completes
Callback when verification fails
{
"event": "verification.completed",
"data": {
"id": "ver_6a7b8c9d0e1f2g3h4i5j",
"status": "completed",
"created_at": "2023-12-30T10:15:30Z",
"completed_at": "2023-12-30T10:17:45Z",
"document_type": "passport",
"verification_details": {
"first_name": "John",
"last_name": "Doe",
"document_number": "X123456",
"expiry_date": "2028-05-20",
"date_of_birth": "1990-01-15"
},
"metadata": {
"user_id": "user-123",
"reference": "order-456"
}
}
}