🔒 Securely authenticate users with FeatureID.
What is a FeatureID?
A FeatureID is our secure proprietary biometric identifier. It is a non-reversible hash, created from a face, typically from a liveness video. FeatureIDs are used to compare with the liveness video during an authentication challenge. You can obtain the FeatureID either from a previous authentication or by performing a Liveness Only authentication for enrollment.
Note
To initiate an authentication, you need to have an access token. Learn how to get your token here.
Step 1: Create an Authentication
To generate an authentication URL, use the POST - Initiate Biometric Authentication
endpoint.
Here's a list of the body parameters:
Parameter | Description |
---|---|
customer_reference | An optional field that you can pass in the request, often used to carry an identifying value. |
liveness_only | Indicates whether the liveness check is required. Set to true if you want to create an authentication via Liveness Only. To create an authentication via FeatureID, set it to false . |
compare_to_featids | The FeatureIDs to be compared with the user's authentication. |
expires_in_seconds | Time in seconds for which the challenge URL is valid. Defaults to 900 (15 minutes). |
require_consent | Flag indicating if user consent is required. If true , the privacy screen will be shown. If false the privacy screen will be hidden. |
flow_behaviour | The flow behaviour object. |
flow_style | The visual and style configurations object of the authentication flow. |
notifications | The webhook notifications object. |
1. flow_behaviour
Object
flow_behaviour
ObjectParameter | Description |
---|---|
exit_redirect_url | The URL where the user will be redirected when the authentication is complete. |
2. flow_style
Object
flow_style
ObjectParameter | Description |
---|---|
primary_colour_hex | The primary color in Hex (e.g., #ffffff). |
header_text_colour_hex | The color of the header text in Hex (e.g., #ffffff). |
body_text_colour_hex | The colour of the body text in Hex (e.g., #ffffff). |
logo_public_url | The public URL of the logo. |
terms_of_service_url | The URL for the terms of service. |
show_consent_checkbox | Indicates whether a consent checkbox should be displayed to users. |
3. notifications
Object
notifications
ObjectParameter | Description |
---|---|
complete | Array of notification configurations for flow completion. |
expired | Array of notification configurations for flow expiration. |
The complete
or expired
array of objects contain the following params:
Parameter | Description |
---|---|
type | The type of supported webhook notification. E.g., http & https. |
properties | The properties of the notifications to send. |
3.1. properties
Object
Parameter | Description |
---|---|
endpoint_url | The URL of the webhook where the notification will be sent. |
authentication | The authentication object. |
3.1.1.authentication
Object
Parameter | Description |
---|---|
type | The authentication type. |
properties | The authentication properties. - oauth_endpoint_url : The URL for OAuth endpoint.- grant : The token grant type, or permission, the default value is client_credentials .- client_id : The client identifier issued by IDVerse to the customer.- client_secret : The client secret issued by IDVerse to the customer. |
Below is an example of the request:
curl --request POST \
--url https://api.au.faceaccess.io/v1/create-challenge \
--header 'Authorization: Basic API_KEY' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"customer_reference":"Example reference",
"liveness_only":false,
"compare_to_featids":[
"VjIwMjIxMjEzOl..." ],
"expires_in_seconds":60,
"require_consent":true,
"flow_behaviour":{
"exit_redirect_url":"https://example.com/redirect"
},
"flow_style":{
"primary_colour_hex":"#000000",
"header_text_colour_hex":"#000000",
"body_text_colour_hex":"#000000",
"logo_public_url":"https://example.com/logo",
"terms_of_service_url":"https://example.com/privacy-policy",
"show_consent_checkbox":true
},
"notifications":{
"complete":[
{
"type":"https",
"properties":{
"endpoint_url":"https://webhook.site/95dcd57a-fb70-4b3a-bf97-6d9edaf69618",
"authentication":{
"type":"oauth",
"properties":{
"oauth_endpoint_url":"https://example.com/endpoint-oauth",
"grant":"client_credentials",
"client_id":"client-id-example",
"client_secret":"client-secret-example"
}
}
}
}
],
"expired":[
{
"type":"https",
"properties":{
"endpoint_url":"https://webhook.site/95dcd57a-fb70-4b3a-bf97-6d9edaf69618",
"authentication":{
"type":"oauth",
"properties":{
"oauth_endpoint_url":"https://example.com/endpoint-oauth",
"grant":"client_credentials",
"client_id":"client-id-example",
"client_secret":"client-secret-example"
}
}
}
}
]
}
}'
Info:
We offer FaceAccess service across multiple regions. When integrating with FaceAccess, ensure that you use the correct Base URL for your region:
- Australia (AU): https://api.au.faceaccess.io
- Canada (CA): https://api.ca.faceaccess.io
- United Kingdom (UK): https://api.uk.faceaccess.io
- United States (US): https://api.us.faceaccess.io
You will receive the following response containing a URL for authentication:
{
"challenge_id": "challenge_id_here",
"challenge_url": "challenge_url_here",
"expires_at": "2023-07-24T08:52:45.243486206Z"
}
Field | Description |
---|---|
challenge_id | The unique identifier assigned to a specific challenge in an authentication process. |
challenge_url | The unique URL assigned to a specific challenge in an authentication process. |
expires_at | The date and time when the authentication will expire. |
Step 2: Complete the Authentication
Once you've received the URL from the API response, you have several options to send it to the end user:
- Redirected to the URL.
- Tap the link to authenticate.
- Scan the URL as a QR code.
- Send the URL through a message or push notification.
- Provide the URL that can be opened in a WebView or frame.
The end-user will go through the authentication process as shown below:
- Please verify your identity by capturing a quick selfie.
- Click on the "Allow" button to grant access to your camera.
- Follow the prompts to capture the selfie. It is private and will only take a few seconds
- Upon completion, you will be redirected to the next page as specified in the
flow_behaviour
URL.
Step 3: Get Webhook Notification
You will receive the authentication results through webhook notifications if the authentication is complete or expired. Here's an example of the complete authentication result via webhook:
{
"challenge_id": "challenge_01JBGGHQPPWJ7R41D3XN88NAR4",
"customer_reference": "Example reference",
"created_at": "2024-10-31T05:25:07.926Z",
"initiated_at": "2024-10-31T05:25:11.779Z",
"expires_at": "2024-10-31T05:26:07.926Z",
"status": "completed",
"closed_reason": "completed",
"consent_required": true,
"consent_given_at": "2024-10-31T05:25:15.564Z",
"events":
[
{
"name": "consent_given",
"timestamp": "2024-10-31T05:25:15.564Z"
}
],
"overall_result": "pass",
"liveness_result":
{
"face": true,
"overall": true,
"smile": true,
"spoof_result": true,
"liveness_featid": "VjIwMjIxMjEzOlsxLjI3OTU5MzIsLTEuMTc2Mzk5MiwtMS41MzAxNjMsLTAuMDgxMDU0OCwtMC40Mjk0NTQzLDIuOTcxMDE1LDEuMzczNzMyNCwtMC45NDM3NCwtMS40NDc5OTMsLTEuMDg2MTk4MSwxLjA4MDgzNDUsLTAuMDcwOTk1NTYsLTAuMTc5Njg1MjIsMC42MDk3NTk0LDEuNTUyOTMxNCwtMi42Nzk4Mjc1LDAuODAwODY3LC0xLjg1NjQyMzUsMS43Njk3NDgzLC0xLjU2NjM0MjcsMC45NzU2NDM0LDAuMjIzMjg0NSwtMC43NTI0NDA4LDAuNjQ0MDQ4MzMsMS4yMjIzNDk1LDEuMTEyMDc0LDAuNjAyMDk1MjUsLTAuMzk0ODQyOTgsLTAuMzc4NDk5MzMsLTAuMDU5NDEzNzI0LC0xLjIxNjMwMTEsMS4wNzQ0NjQ0LC0wLjk4OTc5NDksLTEuMzQyMTA3LC0xLjEyNDk1NjYsMS4yOTUwNTYxLDEuMTcyMzgxMiwwLjU0MDk0MDE3LC0wLjI3NDAyOTUsMC4xOTQyMTA3NCwtMS4wMDQ0ODk1LDAuNTkzODU2MywtMC4xNTczNzAzNywwLjM3NTQzMTksMC4xMDcwMDUxMiwxLjM2NDc5NDcsLTIuMDU2Nzc4NywtMC41MjY3MTA5LC0xLjUzOTk5MDIsMC44ODcyNDkwNSwtMC4yMjEwNDE2MywtMS43MzQxMzM3LDAuMzk4Nzk0NTYsMC40NDg1NzU4LDEuNTI5ODE3NywtMC43MDEwODE0NSwtMC4wMDMyOTA2MjIzLC0wLjc2ODcyMjEsMC40NDI1Nzk4LDEuMjcwNDEyNCwtMC4wNzk2MDA2NCwtMC43NDAwNzMyNiwtMC4xNTY3MTIyLC0wLjM4MjEzNDYsMC40NTM5NjMwNCwtMC42ODAxOTkzLDAuMzAzMTIxNzUsMC44MDU3OTM3LC0wLjQ5Mjg5MDQ1LC0wLjQ1NzYzNTUsLTEuODI1MzQxOCwwLjk4OTk5NDM1LDMuNTEyNzE0NCwtMS43NDI1MTgzLDEuMTQ1NDkwOCwwLjkxMzY3OTY2LC0xLjIzNzQxMiwtMS40Nzc5NTY5LDAuMDkwODI4NDksLTAuMDMyODY1MjY0LC0wLjI2NjQ1NDQsMC43NTg0OTc1NCwtMS40MjE1MDMxLDAuMTIyMDIxMzEsMC41MzY5NjI0LDEuMTQ2OTIzNCwwLjkzODA4OTgsLTAuMDI1OTAwNjg0LDEuMzUxMjIxNiwtMC45NTQ0ODgxNiwwLjc4MTQ4NDYsMS4zNDI2NiwxLjkwODU5NDUsMC4xNzE5OTU1NCwwLjE2MjI3NjU3LC0xLjYxNjU0MjUsMC4xMjc0MDA3MywtMC43MTEzNzEyNCwyLjMyNjExODUsMC42MDE1MDYwNSwtMS45MDUwMzkyLC0wLjA1NzAxMTk2NiwtMC4xMTI2NDcwOTQsLTAuNDg2MDAyMTgsMC42NjM0NTcwNCwwLjI3NzIwNDc1LC0yLjY2NDM1NzIsMS41MDAxNDM0LDEuMzYwMzYyNSwwLjgxMTMzMzYsMS4wMzg5NDA1LDIuMTIyMDgyNSwtMS4xMDMxMTczLC0wLjgzMDkzNTk2LDEuNTg1OTA3OCwtMC42OTIyNjcyLDAuNjk3MDgwNSwwLjIzODA0NDk5LC0yLjE2NjU5ODYsMC4zMzgxNTg3MywxLjcxNjk0OTksMC4xMzc4NjY1MSwwLjY4NTI1NzgsLTAuMTI5NTQ1MywwLjE4NTQxODI2LDAuMzk1NzY0NzcsLTAuMTAyODQwOSwtMC4zMTAwMTcwNSwtMS4wNDM4MTgxLDAuMjg1NDY0MiwwLjk2OTY2MzMsMC4yNTk5NjA0LDAuMDUyMTM4MzIsMC44MzE1OTExLC0wLjc4Mzg4ODE2LDIuMDY5MDEzLC0wLjE5MDA0NzgsLTAuMTgzMDk2ODQsMS42MjQ5Nzk2LDAuMzg1MjkzMjUsLTAuMDE1NDQ4OTMsLTAuNzc1NTI2NywwLjc3NTE4MjYsMC4zMDI1MTMyLC0wLjk1NTMxNiwtMi4zNDkyNTg3LDAuODAyMzU2MDYsLTEuNTM0MTE1MywwLjU2MzM0MTIsMS4yNTQwMTkxLDAuMzQzMzU2ODIsMC45MTA0NTY2LDEuNzE3NDAzNSwwLjE5NjA4OTI1LC0wLjY5MTgzMzUsMC44MTE5NTczLC0xLjY3NDE2MDgsMS4wNzU3MjI2LC0wLjE3Mzg3ODk1LDAuOTcyMDM5NjQsMC42NTkzNDM5NiwtMC40MDAyNTM1MywtMC41OTE4MTkwNSwwLjE0NDI0MDA1LC0wLjkyNjk1OTQ2LDAuNTcyMDA4NCwwLjc4MzQxOTksLTAuNDMxMzEyNCwtMS43Njc3NTg2LDAuNzMxNzM5MywtMC4yNDcwNzgzMSwtMC44ODE5OTk3LC0yLjI0ODI0NDMsLTAuMTQzMDE3MTYsLTAuMjA2OTM0ODIsLTAuMjE1Mzc4NzMsMC40NjYyOTMzLC0wLjgyODYzNzg0LC0wLjYyNzkwNDgsMC4xMjMzNTgwMSwtMS4wMTc5NTc4LDAuNzQ2MTc1MiwtMS4yMzczMzk3LC0wLjk3ODk3MzMsMC42MTIxNjI4LC0wLjYwMDQ5MDc1LC0wLjg1ODk1NDUsMS4wMDI3NTUyLC0xLjM5NDU4NDcsMC40NTU3NjA4NCwtMC4yNzE2NjUwNCwwLjMyMjkzMzgsMC43NTE0ODYzLDAuMTg5MDMxNjIsLTAuNDIyMTQ1MiwtMC45MzgxODgxNCwtMS4zNjA3NjAyLC0wLjc1MzYyMTM0LC0wLjcxNDQ2OTIsMC42MjMxNzA2LC0wLjU2MzQ3MzQsMC41MDUzNTMxLDEuNzMxMTAxNSwtMC44NTM4MDAyLC0wLjI4OTY3MTMsLTIuNDQzOTEwOCwwLjg2MzI5ODUsLTAuNjI2NzM2MSwxLjM4NjA2NzQsMC40NzU1NDM2LDAuNzM2MTk1NCwtMC42ODM5MzA2NCwwLjEwMjQ1NzQ5LC0wLjI1NzIyNTcyLDAuODE0MDc5NSwtMC44NTcwOTMxNiwwLjI1MDM3MzI3LDEuMzU0NjM1NCwtMC43MDQyOTkzMywxLjkxNTU1NDgsLTAuMjEyMDQyODQsLTAuODI4NzgwNiwtMC40OTgzNDU4MiwtMS45NzU4MzQxLC0wLjE1MTM0NTMxLDAuMjMwMzY0OTUsLTAuMDY0MTM2MzcsLTAuMzk3MTc1NCwtMS4yMDQyNTc3LDIuMjIyNjI4NCwtMC4yNTY2MzA0LDIuMTIxNTM4LC0wLjE5ODkxMzk5LDEuMzIwOTI2MSwtMS4xNDQ5NzQ4LC0xLjcxMjMyMzQsLTEuMTc5NDcyMywwLjkxNDI1NzEsMC40NDUxNzA1LC0xLjIyNDMyODUsMC4zNDQ0NTU2MywwLjk5NTI3MSwxLjQ3ODkxMjQsLTAuNjMxMDM2MiwtMC4yODQ2NzI4NiwwLjM0MDA3NjA2LDAuOTA2MjI2NjMsMi45MTc0ODQ1LC0wLjc1NzIwMzY0LC0zLjEyNTExNDQsMS4yMDE5MTYsLTAuMjU5NDI3NjcsMS40NDMwNzI5LDAuMTIzNTE0MjYsLTAuMjY3ODgyNTMsLTEuMTczOTk5MywtMC4zNzM1OTEwNywtMC40MDAwMTI0NiwtMC40NzQ0MDE0NCwxLjE3OTk5MjcsLTAuOTAwNjI1NSwtMC4xNjY5NTA0OCwxLjIxODI4MDIsLTAuNTY4NDk4OCwtMS40NTA5Njk2LC0wLjc0MjQyNjYzLC0wLjExMjMzNzE5NCwtMC41MjYwODc0LC0xLjA0MDE4MzUsMi4wMDI1MDY3LDEuMjkyMzUxNywwLjA2MTI5ODY2LC0wLjIxNDAzMDgsLTEuODA0OTY4MiwtMS4xNTYyMDQ5LC0wLjc0MjE1OTM3LDAuOTA2NjQ2LC0xLjk1NjE4NzcsMC42Mjc3NjY1NSwtMS4zNjEzNzYzLC0xLjU0NjA2NjIsMS4zMDY2OTk4LDEuMjYxNDYsMC45NTY1NzIsLTAuMzQyOTU0MDQsLTAuODY3MjMzMTYsLTEuMDc4Mjc5NSwtMS40OTEzMjA4LC0wLjA2MzUzNTk0LC0wLjU1MTUzMzksLTAuNTk5Nzk2OTUsLTEuMzI4NDcwMiwtMC42NjgzNTk3NiwwLjU0MzA3ODU0LC0wLjEwNDE2MzEsMC41NjUyNzU0MywtMC44NjU4MDY5NCwwLjkzOTQ1OTcsLTAuMDI1ODU0NDQ4LDEuMzE4NzU5MywxLjUyODQzOTQsMS4yMjQ4NzEyLC0wLjcyOTExMTIsMC4xMDUxMTE1OSwxLjM1NDc3NTcsMS4wNDgyMTUyLDAuNzg3NjY2NDQsMi41MTYwNzIsMC4wNTg0MzI4MiwwLjY1MTg4MTY0LC0xLjAyODE5NTMsLTEuNzYyMzg1NSwwLjI5MzcyMTM1LDAuODAzODM2MSwtMC45OTk0NjUxNywwLjQ1NDU4OTc1LDAuMjgyODAzNTcsMC41NzY0MjMxNywxLjI0NTQ1MzYsLTAuODQxNjc0NiwtMC41MzE4NTA2LDEuMTQxNDI5NSwtMC4yNTI1MTc2NCwxLjQ3ODY3MjcsMC42MDc4MDY5LC0xLjEyMTczNywwLjY5NTU2MjM2LC0wLjAxOTAwOTkzNywtMC4zNjQwMzIzLDEuMzk2MDQzNSwxLjA3MDYzMjMsMC42MzMwNDgzNiwxLjE1MzU2OTIsLTAuMjgyNTg4NDgsLTEuMjkyMzg0NSwwLjgzMDEzNjY2LC0xLjc0NzIzMTgsLTAuMTAxODE2OTksLTAuOTc0MTM5MzMsMC40Mjg5NTUyMywwLjQ5MDg1MjQ1LC0wLjc5MzU2NzU0LC0wLjExMDgxMzc3LDAuMTQ5MTc1MjMsLTEuMzM2Njc0OSwtMS40MjMyNjk0LC0wLjE1MTY5MTA4LC0xLjIxMDY2MjEsLTEuNDg4OTA2NiwwLjk5MzM3NDc2LC0yLjE2OTI3MywxLjQ3NTM3MjMsLTAuODM1MDI5LDAuNTM4MTQ4NjQsMC4wMzg3NzQ3LC0xLjI3NjQyOSwtMC45Njk2NTA1LDAuMTg2OTM4NzgsLTAuMTU1NTIyMSwtMS40MjA0ODA0LC0xLjM3MTczNTcsLTEuMTU0NTkzMSwtMC40Mjg0MTIwNSwwLjQ0NDQzMDk1LDAuMjAzMDgwODIsLTEuMDcxOTQ3NywtMC42Mzg3MjE0NywwLjUyMzEwNzA1LC0xLjYyMDQzOCwtMC4yMTk5MzM3MiwtMC4yODIwNzUwMiwwLjE5Njc2NjU3LC0xLjAyNjE1NzEsMC42MTQ5MjcyMywtMC4zMjc3MzY2NSwxLjE5ODExNzksLTEuNTM5ODcxNiwxLjIxNzM4NDksLTAuODA2MzQ5NCwxLjA4NzYyNDEsLTAuMjgyMTcwNDQsMS45NzQ2Njc1LC0wLjMzMTg1MzcyLDEuNTAyNzE2NSwwLjM0NzU0NzgsMS4xMTI2MTUzLC0yLjE2MjE2MiwtMS4xMzUxMzI3LC0yLjA5NDgzNTMsLTAuMTc2OTMyOTMsMS4xNDM5NTMzLC0wLjM3NTg5ODEsMC4wNTIxNDY0NzYsMC4zODk3OTkxLDAuODcyODE5NSwtMC40NDYwOTE0NywwLjgxMTUwNTg1LDAuNDA2Njk4NjQsMC4zODgzODAyNiwwLjc3Mzc2ODYsMC43Mzc5OTgxLDAuNDk0MDIyODgsLTAuNjAzOTEyOSwtMC43ODQxNjM1LDAuNzIzNjc0OSwtMC40NjI5NjM0NiwyLjM4NzkyMSwtMC41Njk1NjkxLC0xLjk4NDE1OTIsMS44OTA1NDA3LDAuOTY0OTkyMTcsMC40MDU2ODA5NSwtMC4yMjU0NzU3LC0xLjI2OTU5OTEsMi40OTQ3NTI0LDEuMTEwODM1OSwtMC4wMjQzMjM0MzQsMC45MzI1NDU0LC0wLjcwNTgxODQsMC4yMTQxMzYxMSwwLjcxMjYxOTcsMC41MjM1ODkxMywwLjY4MzAwODQzLDAuMTUxMzI4NzMsMC4zNDg1NTcsLTAuNjMyMTIyLDAuMDA1MTMxNTEzMywwLjI0MDU3OTY1LDAuNzY1OTQ4NTMsLTAuMTY0Mzk5NjQsMC4xNjAyMjAxLDAuNzk0MDI2MSwwLjgxNzY1NzY1LC0xLjE5MDEzOTgsMS42MzA2NjUsMC4xODU2Mzc1MywyLjM1NDEyMzgsMC42MTMwOTQ1LDEuMzMyMTcxMiwxLjM4NjE3ODEsMC42NTE2NjE3LDAuMDAxMDIxMjY1NSwtMC4yMTExMjU5MSwtMC43OTQwMzEsLTAuODIzOTg5MywtMS4zMDkxMDM1LC0wLjc2Njc2Nzc0LC0zLjQ1Mjk0OTUsMS42MzI3NDEyLC0wLjYxNjE3MDQ3LC0wLjQ1MjYxNDA0LC0wLjkwNDA1ODcsLTAuNjkwNTcyMTQsMS42NDY1MDA2LDEuMjQxNDM0NSwwLjU5NzUxMywtMC4wMDc5MjE1MzYsLTEuNDc4NDk4MSwtMC44MDQ1NTg5LC0wLjQxNDgxNDM1LC0xLjcxODcyODksLTAuOTMwMDUxMjcsMC42NjI2NjM4LC0yLjc4NzgzLC0wLjc4NTI1NDcsMS4zMTczNDEsMS45Njc5Nzg2LDAuMDI3NDg5OTMsMS45MzQ3NTQ0LC0wLjYyNDg0MDUsMC41MDQ4NzQsMC4xNzUxMTgxMywtMC43OTEwNzU5NCwxLjUxNDY4MzYsMC45NzkwMjM5LC0wLjYyMjAxNjgsMS40ODY5MzMsMS40MzE0NjgxLC0yLjQwMjI2NDQsMS45NzMzOTY0LC0wLjk1ODk0OTgsLTAuMDAwOTYzODE4NSwtMC4xNDY1NzU1LC0xLjQzNjk4MjgsLTAuNTk0OTkzMiwwLjQzNTM0MjYsLTEuNDYyMDcxNSwtMS4xMDEyMjk0LC0xLjY0Mjg2MzQsLTEuMDk0ODU3NiwtMC43NzUxODM4NiwtMC44MjQzOTA1LDEuMTYyMTg4LDEuOTE0NjI4OSwwLjI0NzI4NzQyLDAuNDE4ODk3NTQsMS43MDkyNDkzLDEuNjQ5Mjk0MywtMS40MjMzOTQ2LC0wLjI2MDA3MzQsLTAuMDc5MDc4NDA2LDAuNDQ4ODg0MjgsMC43MjA4MzEsMC43MjMwMDksMS40Mjk1NTEyLC0wLjYxNTE1MzczLDEuNjY1MDM5NSwwLjAzNjkyNzg5LDAuNTE3MjczLC0wLjA2OTMyODA4NSwxLjUzMzIzODYsMC4yNTYwMjQ1N10="
},
"match_result":
{
"compared_to_featids":
[
{
"featid": "VjIwMjIxMjEzOlsxLjQ3OTA3NjcsLTEuNDE4Njk3MSwtMS43MTMyODc1LC0wLjAyNjk0MzkxNSwxLjA4ODU1MSwyLjkwMDgwNjQsMC44MDg4ODM5NywtMS4yNTE1NjU3LC0yLjQzMTY2NTQsMC4yOTE0NjQ0NSwxLjIxMjQ4NzEsMC41NDQ3Njc3NCwwLjc2ODA1MzcsMC4yMDUxMTczNywxLjQ5NTU3NzUsLTEuMTg1MzMwOSwwLjU0NTU1NzcsLTAuOTA1NzU2NCwwLjkwNDMzMDEsMC4xMDEyMDkxNiwyLjM2MjQxMDUsLTAuMzE1MDIzNzIsLTAuNDQ0NDYxNDYsMC4zNDAxMTAyLDEuMzkzNzQyMywwLjgyNTcwMzksMC45Mzg0OTg5LC0wLjQyMDc3ODQ4LDAuMjYxMzQ0NSwtMC4wMDEzNzk4NDMzLC0xLjM4MDU3OTEsLTAuMTA3ODA0MTk0LC0wLjkyMjI4ODcsLTEuNTE4MTA3NSwtMC43NTU2MTE4LDAuMzU1NzA3NjUsMS4yOTI5MDQ3LDAuNDI5NTk3NjgsLTAuMTEyNTMwOTMsLTAuNTA0Mjk0MzQsLTAuNTQzMjExMywxLjMyMzgxNjIsMC41NTU1NDI0NywxLjE4OTI2NiwwLjc1NzMxMTgsMC42NzU3MDEyLC0yLjM2NTc0NjcsLTAuMTk0NjY3NjcsLTAuMDU4NTk4MzE3LDEuNjgyNjA3OCwwLjIwMzE3OTg1LC0xLjY1OTQ3NTEsMC4xNzE5OTg4NCwwLjk5NzQyMjc1LDEuMTEzMjYzNCwtMC4yMTAwMzE0MywtMC42NTMyMzAzLC0xLjg3ODY1MjEsLTAuNjgxNjkwNywxLjYwNDY0NDEsMC4yMTEyMDU4NCwtMC42NzExNjkzNCwwLjIyOTc3ODU5LC0wLjY3NjkxNjA2LDAuNTU4NjY5NzUsLTAuODA4NzE4NTYsMS4yMTAxMDUyLDAuMTMyNjc1MjUsMC4wNzI4OTgxMSwtMS41MDYwNzg0LC0xLjM1NTMwMDUsMS4yOTA2NTUxLDIuNjA4MjExOCwtMS4xMjkxODU5LDIuMDMwNzk1NiwtMC4zNzExODcxMiwtMS41NTA2Mjc2LC0wLjE1MzE2NDY1LC0wLjYzMTEwODQsMC41NTc4NjgsLTAuNDMwNjYyOSwwLjg5Nzc4MzY0LC0xLjMxMjUwOTQsMC4zMDIxNTYxNSwwLjc0Mjc3NzM1LDAuMDA0MTkxMDMyNiwwLjcyMTAzNzQ1LDAuMjA4NTc0NSwwLjY3ODc4NjIsMC4xMjUzMTksMS4zOTAyNzAyLDIuNDQxMzk3LDEuNzM3MzA4LDAuNDkxMjIwNTYsMC40ODM0MjYxLC0xLjM2ODA2ODUsMC4xNDcxMjM0LC0wLjAyMjM3MTU4LDEuODk4NzM5LDAuMzkwNTEzMiwtMC44MDU1MTMxNCwwLjEyNjI4NjYsMS41NzQ3OTg3LC0xLjIyNjQwNzYsMC4zMjU2NTUzNCwwLjAxNjM5NjU3MSwtMi42NzAxMTQzLC0wLjM3MzQxMzgsMS4yMTUyMDEzLDAuMzY5NTQ4MSwtMC4xMTU3OTg5NjUsMi4xMzgwMjE1LC0wLjI4NjM4NTYzLC0wLjA3Nzk4MTYxLDAuMTk2NjQ1MDcsLTAuMjcyNTA0MDYsLTAuMDc3NjYzNDgsMC43NDI3MzM1LC0wLjg2MzQzNTksLTAuNzAyMjk0OTUsMC42MDg0NDA4LDAuMDY0MDQ5NTEsMC42ODE4MTE4NywtMC41NDg1ODc2LC0wLjA2OTc0MjU0LDAuNDUwNzk0OCwtMC42MDc4NDQxLC0wLjQ2MDE2NDIyLC0xLjMxMDI3NTYsMC42NDMwNjg2LDEuMDM2MjgwOSwwLjYyNTc2MTE1LDAuMjE5MjA1ODEsMS4yNTcyNzg3LC0xLjU5MTczODgsMC45NzA1MjA4NSwtMC4xNjcxMDc1NCwwLjA2MTY4OTY2NCwyLjU4ODE3NywwLjMxMTc4NTI1LDEuNDc4Mzc3OCwtMS4xNTc0MzQ2LC0wLjMyNjMxODE3LDAuMTYzMDEyNSwwLjMwNjc2NTY1LC0xLjg5OTQ4MTIsMS40MDg1NjkzLC0wLjU2ODQ5MTgsMC40NjkwNDY0LDAuMjY2MTM0MjMsMS4xOTA4NjcyLDAuODk4MDg5MDUsMS41NzA2ODU1LC0wLjM2NTQ4NzQsLTAuNjk5NDk3MywwLjIzNDcxMzcyLC0wLjkwMDM2MDUsMS4wNjA1MTIxLC0wLjQzMjc3MjY3LC0wLjY5MTA2MzUsMC45MTgzOTA2LC0wLjE3NDU3OTcxLC0wLjkzMjc5Nzk3LC0xLjIzODAzODQsLTAuMTg5NzY3NDIsMC4zMzIyMTQxNSwwLjYzNTQ5NiwtMC41NzQ1MDQxNCwtMS4yMjMwNzg2LC0wLjI5NjI4MzEsMC40NTg1NzMwNywtMC43MzU1NzY5LC0xLjEzNTE3NDgsMC4zODU1MTgwNywtMC4wMzg1MDg1NTcsMC40NzA1MTQ3NywwLjAzMjM0NDk3LDAuMzAwNjIzNSwwLjUwMDY3ODksMC4yOTcwNTUsLTAuNzQyNDkyMywxLjQ0NDQzMTEsLTAuNzYzNjI1LC0xLjU1MjI3NTEsMC41ODA4NTQ2LC0xLjA4NjUxOSwtMC4yNjExMzczNywwLjY5NTc5NDQ2LC0xLjMxMjIwODIsMS41MDc3NzQ4LC0wLjU3MDY2MTI1LDAuNzkzMzU0NywwLjE3NDE3ODgxLDAuNzQzNTIxNzUsLTAuMzEzNDgyLDAuMDUxNjMwMzAzLC0wLjczMTU2Mjg1LDAuMjY2MTQxNDcsLTAuNzkxMTMyMTUsMS4zMjMzMTQyLC0wLjY0MjQwOTQ0LDAuMjg1NzA3LDEuNzg2NjU0NCwwLjM3NTQzMzMsMC4yMjYzOTMyLC0yLjQyNDA5MDksMC44MzE4MDU2NSwtMS45NTQyMzA5LDAuMzkxNDE0MiwwLjQ5MDEzMzYsMC45MDM1NDgyNCwtMC40MzY5MTU0MywtMS4zODE5NzkxLDAuMTIzNDA2NjUsMC4xMTYzNzQ0NCwtMC45NTczNzgyNywwLjY3NTA5MjQ2LDAuMDc5MTU2NSwtMC44NzYyNTU0NSwxLjY1NTczLC0wLjEzMDk4NDU3LC0xLjMxOTI3MDYsLTEuMTEzNDUxMSwtMS4wNTIwMzAyLC0wLjgyMzk2MTEsMC43NDA3OTczNCwtMC41MjIwNzMyLDAuMTg2NTAwNzMsLTAuNTE3Njg1MiwyLjQ2MzQ2MjQsLTAuMzQxOTE5MTIsMi4wODQyNywwLjM0MzEzNzM4LDEuODM2NTEzNCwtMS4xNjMyMzQ2LC0xLjAyOTE3MTYsLTEuNjk3ODA0OCwwLjkzMDA2NzgsLTAuMjQ3NjU0NCwtMC4yMzE5ODIxNCwwLjQwMjkyMzUsMC42NjYzNywxLjQ0NTkwMzIsLTEuNjk0MDgyLDAuMTU1MTk4LC0wLjAwMTgwMzQ4MDksMC41NDI3ODEyLDMuMDA0MDU4OCwtMS41MDg5Nzk3LC0yLjMwMjk3MywwLjczODE0NDc2LC0wLjUxNjI3MDYsMC42MjU5MTI3LC0wLjQ0NjMxMzA1LC0wLjY4ODkzMTgsLTEuNjA4MTE1MywtMC4yMDM0ODAwNSwtMS43OTc5NjkyLC0xLjkyMDc5MDQsLTAuMDE5NTQzODc5LDAuNzQwMDY3NywwLjAyMzg5MzEwMSwwLjMyNTg0NDQsLTAuMjQ1Mjc2ODcsLTEuODQ5MDM0OCwtMC43NDM5NTk0LDAuMTkzNDA1MSwwLjE1NTMyODg0LC0wLjQ4ODYyODI3LDIuMDkyMDYyMiwxLjU5MTE4MDcsLTAuMDQ1ODQ4NjUsMC4zNjg4NjMyNSwtMi4yMDQwOTczLC0wLjk5OTIzNDQsLTAuODU5ODYxNywwLjg0MDczMiwtMS4yMjQzNTUzLC0wLjMxMjIyOTE2LC0wLjQyODgyMDE2LC0xLjU3OTU4NDIsMC43NTY4MTIsMS40ODE5MzY3LDEuNDk4MDk4NSwtMC44MTQ3ODYyLC0wLjExMzczMTM0LC0xLjA1MzExMDUsLTEuMzgxMDMzOCwtMC44ODIwNTMyNiwtMC4zMzcyNjA2NiwtMC4xODQwOTk0OCwtMC4wMDY0NTcxMzA0LC0wLjQ0NTQzNzM3LDEuNTE1MjcyNywtMC40NjY0MDc1NywtMC4wNzUxMTM0LC0wLjI3ODMxOTU0LDAuMzU5MjgzNjMsMC41NDUyMzM2LDEuNzczMjcyMywyLjEyNDQ5MywxLjIwNzQxODQsLTAuMTc0NjkxMjIsMC4wNzAzNDYyOSwyLjMwMDc0NTUsMC43MDMzNzIyLDEuMDM2NjA1NCwxLjEzNzY4MTIsMC4wMjM1NTg4NDYsMC45NTY3NzcxNiwtMC41MDMzMzA0NywtMS40MTIyLC0wLjIwNDMyNTE1LDAuNzAxMDY2MiwtMi4yMDU4MjQsMC45NjQ5OTY1LDAuMTUzMjIzMzgsLTAuMTYxOTg4NjgsMC45NjUzNDQzLC0xLjIzNjQ0MywtMC45NTc4MTc0LDAuODE4NzYwMTYsLTAuMDk0ODIwMzY1LDEuMjIxMjQ3NywtMC42Njc0MzM3LC0wLjgwMDYwNDc2LDEuMTg5MjYzNiwwLjYxMTQ4NTQsLTAuMDA5MjIzMzY1LDEuNDYxMjI4OCwxLjI4MTAwOTIsMS44OTEzNzI2LDEuNDA1NDgwNywwLjkzNjUwMzksLTAuNzU0NjA2OCwxLjE3OTQ2NzIsLTEuMDU4MjMyMiwwLjk2MDU4NjQsLTAuNDM2NzA2NDgsMS41NTE0NTI2LDAuODM3OTYyNTcsLTEuMjUwMDc1MiwwLjc3ODgwNjksMC4yOTQ5NDA2OCwtMC4wMDYyNTUxMzczLC0yLjIyODIwMiwtMC4zOTgzMjgsLTAuODYyMjgxMiwtMC44OTQxODA1LDAuNTI2MzAxMywtMS43MjM1ODYsMS4zNTAzNjExLDAuMDQyMjk4MzAyLDEuMDYxMTE3NiwtMC44MjM3NDY3NCwtMS42ODQyNzY2LC0wLjY0NDcwOTQ3LDAuNjQ2ODY2ODYsLTAuMzEzNDE0MDcsLTEuMTU0MDQ2MiwtMC4yNTk0MzExMiwtMC45MzY3NjY2LDAuNTM4NzM1MiwxLjc3MjEzNDcsLTAuMTM1OTYxMiwtMS4zMjc5ODUyLC0wLjM0MTU4MjU3LDEuMjYxNjM2NywtMC4xNzAyMDczNywtMS4wMzI0NzUxLC0wLjI3MzI1ODI0LDAuMDcyNDQ0MzYsLTEuMzY4MTg0OSwxLjAzNjc1NzMsLTAuNDYzNjgxNTgsMC44NTkwNjA5LC0wLjkyNjY4NTMzLDIuMDgxNTkyLC0wLjUzMDIxMDQsMC41NDExNzMsMC42NTcyNzQ2NiwtMC4xNDY0MjAxOCwtMC45MjcxMTY0NSwwLjUzMjEwMzMsMC4zNzc2MjkxMywwLjk0MjgzNDgsLTIuNDI4NjYzLC0xLjA3NjY2NTMsLTAuNjUxMTI2MTUsLTEuMzU1MTEzNiwwLjUzNzE1NjMsLTAuNDIwOTg0MTgsMS41MDMzNzczLDAuNDM4MDg3MTQsMC4wOTAxNjU5MzUsLTAuOTY0NDg3NTUsMC42NzIwOTIxNCwwLjM3MTA2MTkyLDAuMDE2MjQ4MzQsMC4wODExNDAxMywwLjk1MzU3NTUsMC40OTg5NDMwNiwwLjQ1NDQ3NjQsLTAuMjk4NDYwMjcsMC4xMTY0OTY0MiwtMS4wMTQ3OTE0LDIuMDI0OTYwOCwtMS43ODU4ODY5LC0yLjY1NTM0MTQsMS40OTUzODEyLDEuMTI4MDg2LC0wLjI5MTgxOTcsLTAuNzIyMTc4MywtMS4zNjM5MjIxLDIuMDI3MjI3LDAuOTIyMTg1NSwxLjQxNzU4NjksMS4xODA5NjU0LC0wLjU4MzE2MjgsMC40MjkyMDA1MywxLjM0MjExNywtMC41MDkzODY2NiwwLjQ5OTIzMDg2LDAuMTA4NjM3OTY2LDAuMDMxMDgxMjQ0LC0xLjA1NjYzODcsMC4xNTg0ODQ2LC0wLjQ5OTk2NTg1LC0wLjI1NTcxMjYsMS4yODIwMDYzLC0wLjM1ODgzODkyLDEuMDE1NTQ0LC0wLjM0NDYxOTIsLTEuNjk2Nzg3MSwxLjQ5MTEzMzIsMC44ODE3MTQxNywyLjE0MDE1NTYsLTAuMzI1MDU1NCwxLjE5MTQ4MjQsMC44OTE4MDMzLDAuNDcxMTc5NzIsLTAuMzEwMDc4MTcsLTIuMDQ2MjczNywwLjEyMDMzNTE1LC0wLjQ4NzE1MTUsLTAuNjAxMDQ2OSwtMC4xOTYzMDQ4NCwtMi4xMDg2NTk1LDIuMjM3MTIxMywtMS4zMjE0NTg2LDEuMjc2NzMxNiwtMS4zNjk3MjIsLTAuMTY3MTU3MDUsMS45MDQzMzY1LDAuOTI1MTA0NCwwLjA3MTM3MDU4LDAuNjc0OTAxOSwwLjE5MDg2ODY1LC0wLjAzNzg4NDUzNywtMC40MTkzMzc0OCwtMS45MTAwOTg5LC0wLjkyNjYyNjU2LC0wLjAxNzY5NTk5MywtMy41NjMwMjAyLC0wLjQ0MjQ2MTI4LDAuNzY5MzYzNiwxLjE4Nzc0MTMsMS41NzkzMzQ3LDEuNjQxNDcwMSwwLjU4MDc4NDksMC4zMTA2NzEyLC0wLjc1ODk3ODUsLTAuMTIyMTc4OSwtMC4zNTA5MzU2LDAuNTQyNzAwMjMsLTEuNzYwNzUwOSwyLjMwMzU5NjUsMS41ODAwODg3LC0yLjY3NTY3MTMsMC43MjU1NjcxNiwtMC42NjE2ODc2LDAuMjQxNDcwMzgsMC41MzU1NzI3NywtMS4zMTQ5Nzk4LC0wLjY2NjgzNzQ1LDAuMjI4MzY0MjcsLTEuNDM1MzAxLC0xLjcyMjUzMzEsLTEuNDQyOTE4NSwtMC44NDA3OTU5MywtMC4xNTY4ODgwNCwtMC44NDc1Mjk2NSwxLjczNDU5ODQsMS4zMjY4NTUzLDAuOTg4MTM5OCwwLjI0OTk5MTg1LDAuOTg1NzIwMSwxLjgwOTA5MzUsLTAuODYzNDU0NywtMC4xOTI5ODgzMiwtMC4xMTkyOTY0NywwLjE1NTk1ODkyLDAuNjIzMzgzNzYsMi4wNTA0MTg2LDEuODk5NjEzNSwtMS4wMDc3MDg1LDEuMzYzMjM4NSwxLjY5NTY5NzcsMS4yMTczNjEyLC0wLjYwMzI5ODUsMC41MjM5OTMxLDAuMjA1NDMzNDNd",
"score": 1.796971524419292,
"result": "pass"
}
]
},
"assets_links":
[
{
"asset_type": "liveness_video",
"mime_type": "video/webm",
"size_kb": 819917,
"presigned_url": "https://authchallenge-staging-bas-tempchallengeassetsf1ee3-hmpcce3mhwpk.s3.ap-southeast-2.amazonaws.com/challenge_01JBGGHQPPWJ7R41D3XN88NAR4/auth_2bdad5a6-00a7-4470-a617-84dc1f0aa1ef/stream-auth_2bdad5a6-00a7-4470-a617-84dc1f0aa1ef.webm?x-id=GetObject&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAYB2YU3I3NQD7ENGF%2F20241031%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20241031T052528Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=e335dabd427c7e3fea1d5adc3db224ddc062c02bdd870489112d42c5188b646f&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA0aDmFwLXNvdXRoZWFzdC0yIkcwRQIgCs7Ku6TfC1besYQ%2FJAXBZRMr1S37WDHX1%2F23vDqj8rMCIQDTToQ8wMnntV%2FlRJGCJ0VFc%2BW4wxHPktnkaoxkE4sZ5CrhAwiH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDU1MzY5OTgyNjIzMCIMFargcEFSyMUn4h0vKrUDDc7U8fRzrcLIxWdWwE0RbyatjQaq0DHKghNmkdaVxtVzDMyOdEZReEGCaxfjlQtKnZQ4ra9wYAYQ3hKPDsbkqe6piBs%2BnTKs76JfEN2mMN0yaffyYDIKbVN3ONjZoaf1lkS%2FAZH94rjVA08%2BSZLggdRJc8BkfNkO7vhB4UW2G4r%2F79iBPnGt7LIN15vO9WKoBwWHsMbb%2FfwdDL1qllZ1Ls6sELrwRlaHyKZ83wEFKbFdlitO%2BvE%2FPkypuz%2FtMnT4cO0SMvZtWHKQ%2Bl4Zp82YRW%2Fpz3YmpXzz%2FceyOTAbl%2B3QD2La9AH%2BS2hB89xd76mjiZIT9%2Fi2O9wCb%2Ft8382Sv71DldbhJw0LFidNBJ%2F%2F2FQZR6gOfmGhsNx269ts7fZSDk9SLRtapUmuA0eiQd6KagaKybzEn8yx3IlzeCrvqaQo4ElBmf8XRVpIaiYXXcCwGAY9viYF%2Fvub7DJ51%2BLxYTxoLgWTrUwXQvW1LxcME3Q6WnHGTwvzcDKgL5YasgsBGLNmskVGJGThzI7TttHsWtZR9yYE%2FZOY8%2FpTO1yrOogmmQObqTT%2BknXRB4JkVVY%2BRVZCx%2BAwl6iMuQY6ngHAFmgdSnovDxAJjsRfX3zOh72VgtLQFR2x%2F42rJpLkoEuEgBqcTGippQvyX551q%2BHeEsRG6nCJ5yJzfxrgzBfBsXjjsW%2FMeBoHbT9JboqSh6M5p2Flx0Lg3oJvJraASqHwwmV%2BBEpRnYlr6r8WgY9xWseYjhNnOoahi6q0fhcibxVy7H68jEGZ3BdbSTOK1mmpR6yhf8Eh2XkZPKd7WQ%3D%3D",
"presigned_url_valid_until": "2024-10-31T05:35:28.598654609+00:00"
},
{
"asset_type": "best_frame",
"mime_type": "image/bmp",
"size_kb": 921654,
"presigned_url": "https://authchallenge-staging-bas-tempchallengeassetsf1ee3-hmpcce3mhwpk.s3.ap-southeast-2.amazonaws.com/challenge_01JBGGHQPPWJ7R41D3XN88NAR4/auth_2bdad5a6-00a7-4470-a617-84dc1f0aa1ef/frame-0006-auth_2bdad5a6-00a7-4470-a617-84dc1f0aa1ef.bmp?x-id=GetObject&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAYB2YU3I3NQD7ENGF%2F20241031%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20241031T052528Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=616315396edcbf288c2047bce76aa09969c4b2bb3b810f89383eac91aa60f6e5&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA0aDmFwLXNvdXRoZWFzdC0yIkcwRQIgCs7Ku6TfC1besYQ%2FJAXBZRMr1S37WDHX1%2F23vDqj8rMCIQDTToQ8wMnntV%2FlRJGCJ0VFc%2BW4wxHPktnkaoxkE4sZ5CrhAwiH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDU1MzY5OTgyNjIzMCIMFargcEFSyMUn4h0vKrUDDc7U8fRzrcLIxWdWwE0RbyatjQaq0DHKghNmkdaVxtVzDMyOdEZReEGCaxfjlQtKnZQ4ra9wYAYQ3hKPDsbkqe6piBs%2BnTKs76JfEN2mMN0yaffyYDIKbVN3ONjZoaf1lkS%2FAZH94rjVA08%2BSZLggdRJc8BkfNkO7vhB4UW2G4r%2F79iBPnGt7LIN15vO9WKoBwWHsMbb%2FfwdDL1qllZ1Ls6sELrwRlaHyKZ83wEFKbFdlitO%2BvE%2FPkypuz%2FtMnT4cO0SMvZtWHKQ%2Bl4Zp82YRW%2Fpz3YmpXzz%2FceyOTAbl%2B3QD2La9AH%2BS2hB89xd76mjiZIT9%2Fi2O9wCb%2Ft8382Sv71DldbhJw0LFidNBJ%2F%2F2FQZR6gOfmGhsNx269ts7fZSDk9SLRtapUmuA0eiQd6KagaKybzEn8yx3IlzeCrvqaQo4ElBmf8XRVpIaiYXXcCwGAY9viYF%2Fvub7DJ51%2BLxYTxoLgWTrUwXQvW1LxcME3Q6WnHGTwvzcDKgL5YasgsBGLNmskVGJGThzI7TttHsWtZR9yYE%2FZOY8%2FpTO1yrOogmmQObqTT%2BknXRB4JkVVY%2BRVZCx%2BAwl6iMuQY6ngHAFmgdSnovDxAJjsRfX3zOh72VgtLQFR2x%2F42rJpLkoEuEgBqcTGippQvyX551q%2BHeEsRG6nCJ5yJzfxrgzBfBsXjjsW%2FMeBoHbT9JboqSh6M5p2Flx0Lg3oJvJraASqHwwmV%2BBEpRnYlr6r8WgY9xWseYjhNnOoahi6q0fhcibxVy7H68jEGZ3BdbSTOK1mmpR6yhf8Eh2XkZPKd7WQ%3D%3D",
"presigned_url_valid_until": "2024-10-31T05:35:28.598805751+00:00"
}
]
}
Based on the webhook result, it includes the following fields:
Field | Description |
---|---|
challenge_id | An identifier for the authentication challenge. |
customer_reference | An optional field that the client has passed in the request; often used to carry an identifying value. |
created_at | The date and time when the authentication was created. |
initiated_at | The date and time when the authentication was initiated. |
expires_at | The date and time when the authentication expires. |
status | The current status of the authentication. |
closed_reason | The reason why the authentication challenge was closed. |
consent_required | Whether the user's consent was required. |
consent_given_at | The date and time when the consent was given. |
events | The array of authentication event objects. |
overall_result | The overall authentication result, which can be either pass , fail , or null . |
liveness_result | A detailed breakdown of liveness results, including face, overall, smile, and spoof outcomes. The result is either true for successful or false for an unsuccessful match. Please refer to the table below for details. |
match_result | The match result compares the user authentication with FeatureID depending on the type of challenge that was created. The result is either pass for successful or fail for an unsuccessful match. It contains compared_to_featids object. Please refer to the table below for details. |
assets_links | The temporary links that allow access to assets related to the authentication process. Please refer to the table below for details. |
1. events
Object
events
ObjectField | Description |
---|---|
name | The name of an event that occurred during authentication. |
timestamp | The date and time when the event occurred. |
2. liveness_result
Object
liveness_result
ObjectField | Description |
---|---|
face | The result of the liveness check for the user's face. |
overall | The overall liveness result. |
smile | The result of the liveness check for the user's smile. |
spoof_result | The result of the liveness spoof detection check. |
liveness_featid | The liveness FeatureID. |
3. compared_to_featids
Object
compared_to_featids
ObjectField | Description |
---|---|
feat_id | A unique string of characters generated from the person's face. |
score | The authentication score. |
result | The comparison result between the user authentication and FeatureID data. The result is either pass for successful or fail for unsuccessful authentication. |
4. assets_links
Object
assets_links
ObjectField | Description |
---|---|
asset_type | The type of asset (e.g., "liveness_video"). |
mime_type | The MIME type of the asset (e.g., "video/webm" or "image/bmp"). |
size_kb | The size of the asset in kilobytes. |
presigned_url | The temporary links that allow access to the assets, such as a liveness video asset. |
presigned_url_valid_until | The timestamp until the pre-signed URL is valid. |