✅ Verify authentication status.
After the end user completes an authentication, use the POST - Check Authentication Status endpoint to check the status and its details.
Here's a list of the body parameters that you need to put in your API request:
| Parameter | Description |
|---|---|
challenge_id | The unique identifier assigned to a specific challenge in an authentication process. |
Below is an example of the request:
curl --location 'https://api.au.faceaccess.io/v1/challenge-status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0...jhE_w' \
--data '{
"challenge_id": "challenge_01J57AP97XM4P9KGTF48VR9HNZ"
}'
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
It will return a result with the authentication status and details.
{
"challenge_id": "challenge_01JBFTCSEJE4G9XB7T4PVJQR04",
"customer_reference": "Example reference",
"created_at": "2024-10-30T22:57:57.202Z",
"expires_at": "2024-10-30T23:07:57.202Z",
"status": "completed",
"closed_reason": "completed",
"consent_required": true,
"consent_given_at": "2024-10-30T22:58:07.550Z",
"overall_result": "pass",
"liveness_result":
{
"face": true,
"overall": true,
"smile": true,
"spoof_result": true,
"liveness_featid": "VjIwMjIxMjEzOlsxLjI0MzE4NzgsLTAuMjc3MzA3NCwtMS4zNDQyMjQ2LDAuNTM1OTQyNCwwLjM1OTUwMjY0LDMuMDM5MjUzNywwLjcyNTYxNDU1LC0xLjI3MTk1OTEsLTEuOTMxMzY4MSwtMC4wOTQ0NzcxMywxLjQyOTUwNjksMC44MTIxNjA2LC0wLjA3MDg0NTUxNSwwLjQ5NDYwMDIsMS42OTM2Mjk3LC0xLjcyMTUwMTQsMC44NTQ1NTczLC0xLjQyNTc2NTMsMi4wMDQ3NDQsLTAuNDczNjE2OSwwLjc4NTUyLC0wLjU4MjI3OTUsLTEuNDg1NDk3MSwxLjA5NzkxNzksMS4xNTUyNTY2LDEuMTYyMTk1OCwwLjI1NjU0NDIzLC0wLjQ4MDY0MTc1LC0wLjY3NTE4LDAuNzcwNzMxNSwtMC45NjEyMDYxLDAuNjYzODEzMSwtMS4zOTkyMjYsLTEuNDkxNTA3OCwtMS41NTE0MDMyLDEuMzMxNTY3OSwxLjA0NDIzMDcsMC4zMzU5MTI4MiwtMC42NDc1MzgxLDAuODI1Mzk4NDUsMC4xODM1MDMwMiwwLjI1MjQ2NzI0LDAuMTg1NDQ0ODUsLTAuMzAyMDQ0OSwtMC4zODY4NzI0NywxLjAyNTMyNTksLTIuNjcwNTgwMSwtMS4xOTg0NjIsLTEuMjAxODUxMSwxLjM3NDc5NjksLTAuMzkwMDAwOCwtMS4zNzk2MTI2LDAuMDY4MjYzNzksMC44MDUwNTE3NCwwLjgzMjgzNjMzLC0wLjM4NzAzODUzLDAuNTUzNTAwNiwtMC42NDY3NDczLC0wLjAxNjY3MzMzMiwxLjI1MDg2MzksLTAuMzc4MzExNywtMC43ODk0MDQ3LDAuMjA0MTk2NDUsMC4yNjI4OTEyMywwLjMwNTg3NjA4LC0wLjM2NTM5NTY3LDAuMTE4MTEwOTI1LDAuMTYzMzc2MywwLjAwODgzNDE1OCwtMC43NDMxMjg0LC0wLjQzNjUwNjksMC42OTAxMzk4MywzLjAyMzc3MjcsLTAuNzI4MzU3NiwxLjU0MTc5NDEsMC4zMzk5NjAyNSwtMC4yNjI0MTMwOCwtMS40NjM1MzI2LDAuNjk2MDAwNCwxLjAyMjI0LDAuMjcyNTEyNTYsLTAuMDg4MDM0Njc1LC0wLjgyNjUxNDk2LDAuNjc4NTc1NSwwLjQ4NTI2MjEsMC45Nzg0MzgyNiwxLjU4MTYzMjYsMC4wMTQ2MzMwMzYsMC41NTUzNTI3LC0wLjQyNTkzMjk0LDEuMDM5OTU2OCwwLjYzMTgyOTIsMS43Mjk4OTI1LDAuODE4NjU1NDMsLTAuMDczOTcwODcsLTIuMDA4Njg0MiwxLjIyMDQzNjgsLTAuODk4MjAyNjYsMS45NjE0ODQxLDEuMTU0NTc5MywtMi44ODY3NDA3LC0wLjM0Mjk3OTQsLTAuMzI5ODIwNjMsLTEuNzUyMjMyNCwwLjY4MDMxNjYsLTAuNTA4NzIzNCwtMy4zMDczNjUsMC43NTY5MzYxMywwLjg2NjAzNzksMC4zODM5NjY3NywtMC4xMzY2Mzc0LDEuNzM2NjE4OSwtMS41NTk1MzQsLTAuNDU5MTQwNjYsMS4yNDM2ODU3LC0wLjQ5NjI2NDE2LDAuNzM3NDQxNCwtMC40Njk2NjMxLC0xLjY1NDA1MzcsMC4xOTE1NjkwNywxLjU3ODE5MzgsLTAuMDEzNDM2NDU0LDAuMjY4NzYxOCwtMS4wNjUyOTI3LC0wLjYxNjg2OTg3LDAuNjc2NDksMC4yMDk0NzMyOCwwLjI3MTU4MTUzLC0wLjYzNzcyNTUzLC0wLjE2MzEzNDExLDAuOTk4Nzc3NzUsMC41NTE1MDAxLDAuNTg1MzIwMSwwLjgzMzIzMDE0LC0yLjM2ODYwNDcsMi4xNTM3ODksMC4zMjg2Mzc1NywtMC4xNDA3NDMwNiwxLjExOTcyMzMsMC4zMzk1NTI0MywwLjY3MzE0NzUsLTEuMjc1NzE1NywwLjA4Mzk0NTE2LDAuMDA1OTYzMjEzLC0wLjg5MzkyNzEsLTEuOTAzNTc5MiwwLjg5MDQ5MDM1LC0wLjk5OTQ3Njg1LDAuNjYwOTA1NywtMC4wODkwMTA2OCwwLjk3MTIzMzEsMC40OTQ5ODMwMiwxLjQxNDUwMiwwLjk3ODY0MDU2LC0xLjI1MzY4MDYsMC4zNjg3MTY0LC0xLjQ1NzEzODksMC40MDk0NzcwNiwtMC4yNDgyMzMyNiwwLjE0ODgzODY0LDAuMzE3Mjc3MjUsLTAuMTg1ODE1MjQsMC4wMDEzMTYxMjI0LDAuMTk1NDI2MjMsLTEuMjY2NDcxLDEuMzMzNDUwNiwwLjc4MDU5MjE0LC0wLjE0MDM5NjMzLC0xLjA3NjMxNTQsLTAuMTE2MDMyMjksLTAuNjM0MDUzNiwtMS4yMTU0MTg4LC0yLjIwNjk2OCwwLjcxNDMxMTUsMC4xMTYzODk3MywtMC4zMzM0NDE1LC0wLjA1MTA1ODgwNiwtMC44Njk0MjMxNSwtMS4xNzE1NDg0LDAuMDU2Njg5MzgsMC4wNjA5ODkzNzYsMC4yODM5MTU3MywtMS4wMDMyMTcsLTEuNzg0NzUxNCwwLjY3ODI0MDQsLTAuNzIzODA3OSwtMS4wNDc5NzA1LDEuMjA3NjM5NywtMS44NTQ0OTMxLDAuODQyMTc3ODcsLTAuMjM2OTEyNDEsLTAuMDI0NjcwOTQ1LDAuNTg2OTY4ODQsLTAuMDM0NTg0OTcsLTAuMjE2NjY5OSwtMC43MzU3MzY2NywtMS4xOTI0MDI1LC0wLjE3MTMyMDkyLC0wLjQ3MTU1NzgsMC4zODY5ODkxLC0xLjI4MzYwMDIsMC43MjE5NDc3LDIuMDExODAzNCwwLjA5MTkzNDQ3LC0wLjIzNTQzOTQ2LC0yLjc1Mzk2NTEsMC4xMjQxMDc3MiwtMS41NzU0NzEzLDAuNjA0MjkyMSwwLjE3NTYwNTM0LDAuNzkwNjk4OTUsLTAuNjgzMDA5NiwtMC43MTYxMzY5LC0wLjAwNjA0MzU3NiwxLjIxNTkyNTMsLTAuODEzMTU4MDQsLTAuMDc3NTE1MzQsMC43NDQ0ODYxLC0wLjE0NzAzMDgyLDEuOTQ3ODM1LC0wLjMyNjU2ODIyLC0wLjQxNjI5MDY3LC0xLjI2OTUzMjEsLTEuMTk3MDIzMiwtMC40NTMxNjg4LC0wLjI0OTE0NDQ1LC0wLjE3NzIxMjA3LC0wLjA5Njc3NjU5LC0wLjkwMDI0NDA2LDEuNzc2OTk1LC0wLjAwNDYzMDcwMjUsMS44MjY2NTMxLDAuMjk0NDgwOCwxLjgxOTg5OSwtMC40MzY0MDg4MiwtMS4zMzE0NTE4LC0xLjMyNzE5ODMsLTAuMzc2NTYyMTgsMC4xMjU1NDk2LC0xLjA1NzU2MDcsLTAuMTIzNzQwOTksMC40Mzk5OTEyNCwxLjE1MzAxNjgsLTAuNjUyNDQ0MSwwLjAyMDIzODY2LDAuMzAwNTI0OTUsMC40OTYwODEyNiwxLjY2ODk5MDMsLTEuMDE1NDQ4LC0yLjg3NjE3MDQsMC40NDE4NzY3LC0xLjI4MjkyMDcsMC4xNzcyNTg3OSwwLjc0MTUzNTI1LDAuNDczODU2NzgsLTEuNzY5NTA1OSwtMC42ODM1NjMsMC4xNjYyNjA4LC0wLjkyMzc3OTMsMC4zMTAwNTY1LDAuMDU0MDc1OTk3LC0wLjQyMDk5NjMsMC40NTQ0MzY5LC0wLjgyMzc4MywtMS4yMjgxODEyLC0wLjI1ODAzOTYsMC41ODI1MDQxLC0wLjYzNzMwNzY0LC0wLjcwODQyNTQsMS43Mjk4NzIsMS4yMzY3ODAzLDAuNDkwMDM2NiwtMC4xNjgyMjkxMywtMi4yNjQ0MTgsLTEuMDQxMzYxLC0wLjUzNjU4MSwwLjQzODkyMTMzLC0xLjAwNDA2OTcsMC4xNzc2OTQzNSwwLjA1NjQ3NTEsLTEuMjY2NDg3NSwxLjY0Nzk1NjQsMS4xMTk3NDU0LDEuMDQwMjM0NiwtMC4yMTI2NTI0NiwtMC4xMjEyMjQ0NSwtMC45MjIzMzEsLTAuODYyNzQwMDQsLTAuMjM2NjI0NTEsLTAuNzIxODAxNzYsLTEuNDE2Njk2MiwtMS43MzU4NzY5LC0wLjY0MjYxNzMsMC45MjkzOTAxMywtMC41OTg1NTYxLDAuNTAxNDQ2MSwtMS44NDQ0MTMsMC45MjgzOTYxLC0wLjgwMjUyMTIsMS4wNjQ1MTIsMC42NjI3MzI3LDEuNDg5MzM3NCwtMS42NjQ4NTQsMC41OTYwMjQ0NSwxLjc5MzYyLDEuMzQxMjk5MiwwLjkxMDE5MzU2LDEuNjE0MDY3NywtMC40MDAxNjIyMiwwLjk4MjU5NjE2LC0wLjY2MjAwMTEsLTEuNzk1OTQ4MywwLjU2OTY0NjQsLTAuMjA4NzUzOTEsLTEuMjE2OTU3OSwwLjU0MjU4NTYsLTAuMDQ0NTUxNTE4LDAuNTA3NjM1MiwxLjI2Mzk3MjMsLTEuMDQ2NTgwNywwLjUxMjY3NzY3LDEuNDcxMzkyNSwtMC41NzQ0MjI5LDAuODgxODQzOCwtMC4wODAzNDE5MywtMS4yOTAxNjU5LDAuODExMjU2MSwwLjI1OTg4MjE4LDAuMDk4MjE5MDMsMS4yNTQ2MDg0LDAuMjg1NDkyNjMsMS4zMDk2NTMsMS45MjQ5OTQzLC0wLjAyODk3MTkzOCwtMS4wMzY1NjE1LDEuMDgyMDQ4NCwtMS45NjExNTA0LDAuMTAzNTg4NiwtMC43OTYwNTM2NSwxLjA4MjE5MywxLjUyMTgzNjQsLTAuMzQ3OTAxNzYsMC4zNzkwNDE4OCwtMC4xMzQ3NDAzNSwtMC43Njk2MTc4NiwtMS42NzIyODcxLDAuNDA5NDc1OCwtMS42NzYyNiwtMS4yMTg5ODM4LDEuMDg5NzE2LC0xLjc3MDI2MTgsMi41NTE3ODI0LC0wLjM5MjE4NDA1LC0wLjMyNzYxMDY3LC0wLjg5MDc2NTYsLTEuMzUzOTg4LC0wLjc5MDM0MDY2LC0wLjA3MjE5NDExNCwtMC40MTk1MDM1NCwtMC43NDgwODQwNywtMC42MzE4NTkyNCwtMS4zOTI1Mjg1LDAuMjA1OTk5OTksMS4zNzI2NDIsMC41NzU4MTMwNiwtMC42MjQyODMsMC4wMDc5MTYyODMsMC45ODU0OTIsLTEuNDIxNTYsLTAuOTY5MTMwMiwtMC4xMDMxMDUxNiwxLjAwMTkwOSwtMC42ODU0NzkxLDAuNzc4NjA3NCwtMC42OTUyODMsMS4zNTMzNTA1LC0wLjc1NTk2NjI1LDEuMTcyNjgzMSwtMC4xNzU4MDI5OCwwLjU5NzExODU2LDAuMjQ2MDI0OTQsMC44MTgxNDY0NywtMC40NTE1NDgzLDEuNTc1NTI3NSwwLjQxODU4Njk0LDAuNjQwMjc2NCwtMS40MjMwNTY3LC0xLjAzNzM1NjEsLTEuMzEwNzQyMSwtMC4xODg2MjY4LDEuMDc5MTgyNSwwLjQxODg0ODQzLDEuMDc0MzAwOCwxLjQzMTIxNTQsMS40NTE5ODIsLTEuNDU4NDIyOSwxLjQ5MzcwMDQsMS4wMjUyNDk3LC0wLjY2NDAzMjM0LDAuMTI4MzczOTcsMC45NjIzMjA0LDAuMzc5OTcwNTUsLTAuMTU1NDI2MiwtMC43NDAxMTYxLDAuNTI0NjE3OSwtMC42MjU4MzUxLDIuMTYyNjUyNywtMC40MjM2ODQ3NSwtMS42MDkzODU4LDAuODczMDE4NSwwLjQzNjYyNzU0LDAuMDY2MDIwMzU1LDAuNDAxNDcyOTYsLTEuNzI3NzExNCwyLjE3ODA1MzYsMS4wNjU3ODE0LDAuNjgyMDYyNCwtMC4yNTk1NjAyLC0wLjk5MDc2MzM3LDAuMjk5MDc3NiwwLjg0NDY2MTUzLDAuOTQ0NzIwNSwwLjMyNDQ3NDI1LC0wLjI5Nzg1NTU2LDAuMjg1MTEwNSwtMC44NDQzMDUzNCwwLjU3OTY4ODEzLDAuODMxMTMzNiwwLjAyNjMwNTMxOCwwLjYzODQwOTksMC4wMzcwNzk4OSwwLjAxMTkzMjkzNjUsMC4wNDk2MzEzMiwtMi40NzExMTYsMC43MTYwMzAyNCwwLjEwODczNDQyLDEuOTgzMTY3MywwLjM5NTk0MTg4LDAuMTU1NTIyMzIsMC41Njg2MjA3NCwwLjIxMjAwMzk1LC0wLjA5NzM4NzA5LC0xLjA5MDkzMjcsLTAuMDkzNDYwNjIsLTAuOTQ4Nzk5LC0xLjQzODAzNDksLTEuMDIwOTIsLTEuMTU4NDA2NywwLjI5MTcyMjYzLC0wLjM3NTE3MDgsMS4yMjU3Nzg5LC0xLjI4Nzc5NTcsLTAuNDI5OTgyNiwyLjMwMTYwODgsMC42ODI0Mzg3LC0wLjAxNDE5NTg5LDAuMzIyNzg0ODcsLTEuMDY1MTI2OCwtMC43NjU5NzA2LC0wLjQ0MjMxNSwtMS4yNjc4MzczLC0wLjQ0OTk4NzIzLDAuMjYzNTc2MTgsLTEuNjM5MTczOSwwLjg1MTIxOTgsMS4yNTAxNDIxLDEuODA3NiwtMC4yNzgzMTU4NywxLjgzMzk1MDIsLTAuNTIwOTYwNiwwLjc0NjExNzgzLDAuMTc0NDUxNTYsLTEuNDc5NzczNSwtMC41ODYzMDQwNywwLjk2OTcwNTM0LC0xLjc0Mzk5ODQsMS4xNTUzMzE3LDAuNjg3MjQ2MjYsLTEuNjkzODI3MiwxLjkzNDY1OTQsMC4zNTM3MDAwNywwLjc1MTcyOTMsMC4yNTc1ODgwNiwtMS42NjA2NDM3LDAuMzczMDAzMTgsMC40NzAyMjMzNywtMS40OTIxMzIsLTAuODAxNzQ3NDQsLTIuMDEyMDg3MywtMS40MTkyMjMzLC0wLjM5MTMxNzM0LC0xLjEzMTQ5MzksMS40NDc3MzQsMS4yNzg4Njg2LDAuNTE5MDg1MywwLjc4Njc2NzU0LDEuMjc4NDQ0MywxLjU1MzU5NTcsMC40MDA0MTgwNCwwLjEwMTQ5NTE2LDAuNDcyNTA5MDMsMC4zOTc2MTM3MywxLjAzMTAyMzQsMC42MTg4NDg4NiwyLjAwNTEyNjUsMC4xMjczNzgxLDEuMzA1MDkwOCwxLjUwNjMyNjIsMS41MDE5MTcxLC0wLjAwMjcxODU4NDQsMS4wMzIzOTI1LDAuMDg1NDg0MDhd"
},
"match_result":
{
"liveness_featid": "VjIwMjIxMjEzOlsxLjI0MzE4NzgsLTAuMjc3MzA3NCwtMS4zNDQyMjQ2LDAuNTM1OTQyNCwwLjM1OTUwMjY0LDMuMDM5MjUzNywwLjcyNTYxNDU1LC0xLjI3MTk1OTEsLTEuOTMxMzY4MSwtMC4wOTQ0NzcxMywxLjQyOTUwNjksMC44MTIxNjA2LC0wLjA3MDg0NTUxNSwwLjQ5NDYwMDIsMS42OTM2Mjk3LC0xLjcyMTUwMTQsMC44NTQ1NTczLC0xLjQyNTc2NTMsMi4wMDQ3NDQsLTAuNDczNjE2OSwwLjc4NTUyLC0wLjU4MjI3OTUsLTEuNDg1NDk3MSwxLjA5NzkxNzksMS4xNTUyNTY2LDEuMTYyMTk1OCwwLjI1NjU0NDIzLC0wLjQ4MDY0MTc1LC0wLjY3NTE4LDAuNzcwNzMxNSwtMC45NjEyMDYxLDAuNjYzODEzMSwtMS4zOTkyMjYsLTEuNDkxNTA3OCwtMS41NTE0MDMyLDEuMzMxNTY3OSwxLjA0NDIzMDcsMC4zMzU5MTI4MiwtMC42NDc1MzgxLDAuODI1Mzk4NDUsMC4xODM1MDMwMiwwLjI1MjQ2NzI0LDAuMTg1NDQ0ODUsLTAuMzAyMDQ0OSwtMC4zODY4NzI0NywxLjAyNTMyNTksLTIuNjcwNTgwMSwtMS4xOTg0NjIsLTEuMjAxODUxMSwxLjM3NDc5NjksLTAuMzkwMDAwOCwtMS4zNzk2MTI2LDAuMDY4MjYzNzksMC44MDUwNTE3NCwwLjgzMjgzNjMzLC0wLjM4NzAzODUzLDAuNTUzNTAwNiwtMC42NDY3NDczLC0wLjAxNjY3MzMzMiwxLjI1MDg2MzksLTAuMzc4MzExNywtMC43ODk0MDQ3LDAuMjA0MTk2NDUsMC4yNjI4OTEyMywwLjMwNTg3NjA4LC0wLjM2NTM5NTY3LDAuMTE4MTEwOTI1LDAuMTYzMzc2MywwLjAwODgzNDE1OCwtMC43NDMxMjg0LC0wLjQzNjUwNjksMC42OTAxMzk4MywzLjAyMzc3MjcsLTAuNzI4MzU3NiwxLjU0MTc5NDEsMC4zMzk5NjAyNSwtMC4yNjI0MTMwOCwtMS40NjM1MzI2LDAuNjk2MDAwNCwxLjAyMjI0LDAuMjcyNTEyNTYsLTAuMDg4MDM0Njc1LC0wLjgyNjUxNDk2LDAuNjc4NTc1NSwwLjQ4NTI2MjEsMC45Nzg0MzgyNiwxLjU4MTYzMjYsMC4wMTQ2MzMwMzYsMC41NTUzNTI3LC0wLjQyNTkzMjk0LDEuMDM5OTU2OCwwLjYzMTgyOTIsMS43Mjk4OTI1LDAuODE4NjU1NDMsLTAuMDczOTcwODcsLTIuMDA4Njg0MiwxLjIyMDQzNjgsLTAuODk4MjAyNjYsMS45NjE0ODQxLDEuMTU0NTc5MywtMi44ODY3NDA3LC0wLjM0Mjk3OTQsLTAuMzI5ODIwNjMsLTEuNzUyMjMyNCwwLjY4MDMxNjYsLTAuNTA4NzIzNCwtMy4zMDczNjUsMC43NTY5MzYxMywwLjg2NjAzNzksMC4zODM5NjY3NywtMC4xMzY2Mzc0LDEuNzM2NjE4OSwtMS41NTk1MzQsLTAuNDU5MTQwNjYsMS4yNDM2ODU3LC0wLjQ5NjI2NDE2LDAuNzM3NDQxNCwtMC40Njk2NjMxLC0xLjY1NDA1MzcsMC4xOTE1NjkwNywxLjU3ODE5MzgsLTAuMDEzNDM2NDU0LDAuMjY4NzYxOCwtMS4wNjUyOTI3LC0wLjYxNjg2OTg3LDAuNjc2NDksMC4yMDk0NzMyOCwwLjI3MTU4MTUzLC0wLjYzNzcyNTUzLC0wLjE2MzEzNDExLDAuOTk4Nzc3NzUsMC41NTE1MDAxLDAuNTg1MzIwMSwwLjgzMzIzMDE0LC0yLjM2ODYwNDcsMi4xNTM3ODksMC4zMjg2Mzc1NywtMC4xNDA3NDMwNiwxLjExOTcyMzMsMC4zMzk1NTI0MywwLjY3MzE0NzUsLTEuMjc1NzE1NywwLjA4Mzk0NTE2LDAuMDA1OTYzMjEzLC0wLjg5MzkyNzEsLTEuOTAzNTc5MiwwLjg5MDQ5MDM1LC0wLjk5OTQ3Njg1LDAuNjYwOTA1NywtMC4wODkwMTA2OCwwLjk3MTIzMzEsMC40OTQ5ODMwMiwxLjQxNDUwMiwwLjk3ODY0MDU2LC0xLjI1MzY4MDYsMC4zNjg3MTY0LC0xLjQ1NzEzODksMC40MDk0NzcwNiwtMC4yNDgyMzMyNiwwLjE0ODgzODY0LDAuMzE3Mjc3MjUsLTAuMTg1ODE1MjQsMC4wMDEzMTYxMjI0LDAuMTk1NDI2MjMsLTEuMjY2NDcxLDEuMzMzNDUwNiwwLjc4MDU5MjE0LC0wLjE0MDM5NjMzLC0xLjA3NjMxNTQsLTAuMTE2MDMyMjksLTAuNjM0MDUzNiwtMS4yMTU0MTg4LC0yLjIwNjk2OCwwLjcxNDMxMTUsMC4xMTYzODk3MywtMC4zMzM0NDE1LC0wLjA1MTA1ODgwNiwtMC44Njk0MjMxNSwtMS4xNzE1NDg0LDAuMDU2Njg5MzgsMC4wNjA5ODkzNzYsMC4yODM5MTU3MywtMS4wMDMyMTcsLTEuNzg0NzUxNCwwLjY3ODI0MDQsLTAuNzIzODA3OSwtMS4wNDc5NzA1LDEuMjA3NjM5NywtMS44NTQ0OTMxLDAuODQyMTc3ODcsLTAuMjM2OTEyNDEsLTAuMDI0NjcwOTQ1LDAuNTg2OTY4ODQsLTAuMDM0NTg0OTcsLTAuMjE2NjY5OSwtMC43MzU3MzY2NywtMS4xOTI0MDI1LC0wLjE3MTMyMDkyLC0wLjQ3MTU1NzgsMC4zODY5ODkxLC0xLjI4MzYwMDIsMC43MjE5NDc3LDIuMDExODAzNCwwLjA5MTkzNDQ3LC0wLjIzNTQzOTQ2LC0yLjc1Mzk2NTEsMC4xMjQxMDc3MiwtMS41NzU0NzEzLDAuNjA0MjkyMSwwLjE3NTYwNTM0LDAuNzkwNjk4OTUsLTAuNjgzMDA5NiwtMC43MTYxMzY5LC0wLjAwNjA0MzU3NiwxLjIxNTkyNTMsLTAuODEzMTU4MDQsLTAuMDc3NTE1MzQsMC43NDQ0ODYxLC0wLjE0NzAzMDgyLDEuOTQ3ODM1LC0wLjMyNjU2ODIyLC0wLjQxNjI5MDY3LC0xLjI2OTUzMjEsLTEuMTk3MDIzMiwtMC40NTMxNjg4LC0wLjI0OTE0NDQ1LC0wLjE3NzIxMjA3LC0wLjA5Njc3NjU5LC0wLjkwMDI0NDA2LDEuNzc2OTk1LC0wLjAwNDYzMDcwMjUsMS44MjY2NTMxLDAuMjk0NDgwOCwxLjgxOTg5OSwtMC40MzY0MDg4MiwtMS4zMzE0NTE4LC0xLjMyNzE5ODMsLTAuMzc2NTYyMTgsMC4xMjU1NDk2LC0xLjA1NzU2MDcsLTAuMTIzNzQwOTksMC40Mzk5OTEyNCwxLjE1MzAxNjgsLTAuNjUyNDQ0MSwwLjAyMDIzODY2LDAuMzAwNTI0OTUsMC40OTYwODEyNiwxLjY2ODk5MDMsLTEuMDE1NDQ4LC0yLjg3NjE3MDQsMC40NDE4NzY3LC0xLjI4MjkyMDcsMC4xNzcyNTg3OSwwLjc0MTUzNTI1LDAuNDczODU2NzgsLTEuNzY5NTA1OSwtMC42ODM1NjMsMC4xNjYyNjA4LC0wLjkyMzc3OTMsMC4zMTAwNTY1LDAuMDU0MDc1OTk3LC0wLjQyMDk5NjMsMC40NTQ0MzY5LC0wLjgyMzc4MywtMS4yMjgxODEyLC0wLjI1ODAzOTYsMC41ODI1MDQxLC0wLjYzNzMwNzY0LC0wLjcwODQyNTQsMS43Mjk4NzIsMS4yMzY3ODAzLDAuNDkwMDM2NiwtMC4xNjgyMjkxMywtMi4yNjQ0MTgsLTEuMDQxMzYxLC0wLjUzNjU4MSwwLjQzODkyMTMzLC0xLjAwNDA2OTcsMC4xNzc2OTQzNSwwLjA1NjQ3NTEsLTEuMjY2NDg3NSwxLjY0Nzk1NjQsMS4xMTk3NDU0LDEuMDQwMjM0NiwtMC4yMTI2NTI0NiwtMC4xMjEyMjQ0NSwtMC45MjIzMzEsLTAuODYyNzQwMDQsLTAuMjM2NjI0NTEsLTAuNzIxODAxNzYsLTEuNDE2Njk2MiwtMS43MzU4NzY5LC0wLjY0MjYxNzMsMC45MjkzOTAxMywtMC41OTg1NTYxLDAuNTAxNDQ2MSwtMS44NDQ0MTMsMC45MjgzOTYxLC0wLjgwMjUyMTIsMS4wNjQ1MTIsMC42NjI3MzI3LDEuNDg5MzM3NCwtMS42NjQ4NTQsMC41OTYwMjQ0NSwxLjc5MzYyLDEuMzQxMjk5MiwwLjkxMDE5MzU2LDEuNjE0MDY3NywtMC40MDAxNjIyMiwwLjk4MjU5NjE2LC0wLjY2MjAwMTEsLTEuNzk1OTQ4MywwLjU2OTY0NjQsLTAuMjA4NzUzOTEsLTEuMjE2OTU3OSwwLjU0MjU4NTYsLTAuMDQ0NTUxNTE4LDAuNTA3NjM1MiwxLjI2Mzk3MjMsLTEuMDQ2NTgwNywwLjUxMjY3NzY3LDEuNDcxMzkyNSwtMC41NzQ0MjI5LDAuODgxODQzOCwtMC4wODAzNDE5MywtMS4yOTAxNjU5LDAuODExMjU2MSwwLjI1OTg4MjE4LDAuMDk4MjE5MDMsMS4yNTQ2MDg0LDAuMjg1NDkyNjMsMS4zMDk2NTMsMS45MjQ5OTQzLC0wLjAyODk3MTkzOCwtMS4wMzY1NjE1LDEuMDgyMDQ4NCwtMS45NjExNTA0LDAuMTAzNTg4NiwtMC43OTYwNTM2NSwxLjA4MjE5MywxLjUyMTgzNjQsLTAuMzQ3OTAxNzYsMC4zNzkwNDE4OCwtMC4xMzQ3NDAzNSwtMC43Njk2MTc4NiwtMS42NzIyODcxLDAuNDA5NDc1OCwtMS42NzYyNiwtMS4yMTg5ODM4LDEuMDg5NzE2LC0xLjc3MDI2MTgsMi41NTE3ODI0LC0wLjM5MjE4NDA1LC0wLjMyNzYxMDY3LC0wLjg5MDc2NTYsLTEuMzUzOTg4LC0wLjc5MDM0MDY2LC0wLjA3MjE5NDExNCwtMC40MTk1MDM1NCwtMC43NDgwODQwNywtMC42MzE4NTkyNCwtMS4zOTI1Mjg1LDAuMjA1OTk5OTksMS4zNzI2NDIsMC41NzU4MTMwNiwtMC42MjQyODMsMC4wMDc5MTYyODMsMC45ODU0OTIsLTEuNDIxNTYsLTAuOTY5MTMwMiwtMC4xMDMxMDUxNiwxLjAwMTkwOSwtMC42ODU0NzkxLDAuNzc4NjA3NCwtMC42OTUyODMsMS4zNTMzNTA1LC0wLjc1NTk2NjI1LDEuMTcyNjgzMSwtMC4xNzU4MDI5OCwwLjU5NzExODU2LDAuMjQ2MDI0OTQsMC44MTgxNDY0NywtMC40NTE1NDgzLDEuNTc1NTI3NSwwLjQxODU4Njk0LDAuNjQwMjc2NCwtMS40MjMwNTY3LC0xLjAzNzM1NjEsLTEuMzEwNzQyMSwtMC4xODg2MjY4LDEuMDc5MTgyNSwwLjQxODg0ODQzLDEuMDc0MzAwOCwxLjQzMTIxNTQsMS40NTE5ODIsLTEuNDU4NDIyOSwxLjQ5MzcwMDQsMS4wMjUyNDk3LC0wLjY2NDAzMjM0LDAuMTI4MzczOTcsMC45NjIzMjA0LDAuMzc5OTcwNTUsLTAuMTU1NDI2MiwtMC43NDAxMTYxLDAuNTI0NjE3OSwtMC42MjU4MzUxLDIuMTYyNjUyNywtMC40MjM2ODQ3NSwtMS42MDkzODU4LDAuODczMDE4NSwwLjQzNjYyNzU0LDAuMDY2MDIwMzU1LDAuNDAxNDcyOTYsLTEuNzI3NzExNCwyLjE3ODA1MzYsMS4wNjU3ODE0LDAuNjgyMDYyNCwtMC4yNTk1NjAyLC0wLjk5MDc2MzM3LDAuMjk5MDc3NiwwLjg0NDY2MTUzLDAuOTQ0NzIwNSwwLjMyNDQ3NDI1LC0wLjI5Nzg1NTU2LDAuMjg1MTEwNSwtMC44NDQzMDUzNCwwLjU3OTY4ODEzLDAuODMxMTMzNiwwLjAyNjMwNTMxOCwwLjYzODQwOTksMC4wMzcwNzk4OSwwLjAxMTkzMjkzNjUsMC4wNDk2MzEzMiwtMi40NzExMTYsMC43MTYwMzAyNCwwLjEwODczNDQyLDEuOTgzMTY3MywwLjM5NTk0MTg4LDAuMTU1NTIyMzIsMC41Njg2MjA3NCwwLjIxMjAwMzk1LC0wLjA5NzM4NzA5LC0xLjA5MDkzMjcsLTAuMDkzNDYwNjIsLTAuOTQ4Nzk5LC0xLjQzODAzNDksLTEuMDIwOTIsLTEuMTU4NDA2NywwLjI5MTcyMjYzLC0wLjM3NTE3MDgsMS4yMjU3Nzg5LC0xLjI4Nzc5NTcsLTAuNDI5OTgyNiwyLjMwMTYwODgsMC42ODI0Mzg3LC0wLjAxNDE5NTg5LDAuMzIyNzg0ODcsLTEuMDY1MTI2OCwtMC43NjU5NzA2LC0wLjQ0MjMxNSwtMS4yNjc4MzczLC0wLjQ0OTk4NzIzLDAuMjYzNTc2MTgsLTEuNjM5MTczOSwwLjg1MTIxOTgsMS4yNTAxNDIxLDEuODA3NiwtMC4yNzgzMTU4NywxLjgzMzk1MDIsLTAuNTIwOTYwNiwwLjc0NjExNzgzLDAuMTc0NDUxNTYsLTEuNDc5NzczNSwtMC41ODYzMDQwNywwLjk2OTcwNTM0LC0xLjc0Mzk5ODQsMS4xNTUzMzE3LDAuNjg3MjQ2MjYsLTEuNjkzODI3MiwxLjkzNDY1OTQsMC4zNTM3MDAwNywwLjc1MTcyOTMsMC4yNTc1ODgwNiwtMS42NjA2NDM3LDAuMzczMDAzMTgsMC40NzAyMjMzNywtMS40OTIxMzIsLTAuODAxNzQ3NDQsLTIuMDEyMDg3MywtMS40MTkyMjMzLC0wLjM5MTMxNzM0LC0xLjEzMTQ5MzksMS40NDc3MzQsMS4yNzg4Njg2LDAuNTE5MDg1MywwLjc4Njc2NzU0LDEuMjc4NDQ0MywxLjU1MzU5NTcsMC40MDA0MTgwNCwwLjEwMTQ5NTE2LDAuNDcyNTA5MDMsMC4zOTc2MTM3MywxLjAzMTAyMzQsMC42MTg4NDg4NiwyLjAwNTEyNjUsMC4xMjczNzgxLDEuMzA1MDkwOCwxLjUwNjMyNjIsMS41MDE5MTcxLC0wLjAwMjcxODU4NDQsMS4wMzIzOTI1LDAuMDg1NDg0MDhd"
},
"assets_links":
[
{
"asset_type": "liveness_video",
"mime_type": "video/webm",
"presigned_url": "https://authchallenge-staging-bas-tempchallengeassetsf1ee3-hmpcce3mhwpk.s3.ap-southeast-2.amazonaws.com/challenge_01JBFTCSEJE4G9XB7T4PVJQR04/auth_32897196-0b36-4e0e-a769-eecc8767f9e1/stream-auth_32897196-0b36-4e0e-a769-eecc8767f9e1.webm?x-id=GetObject&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAYB2YU3I3AKUD7YCG%2F20241030%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20241030T225826Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=422aac7172c109a56b4f9a950b2cf1006522d66385cf5f8a3ca25b8440aa27de&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAcaDmFwLXNvdXRoZWFzdC0yIkYwRAIgPxfTZfDIU3hSyIweH4Pr%2FdQbMMucMC%2BnSXj1lkSWBJYCIFcv%2FA0uHGigSLRUDcGrJ98KZPbQZHMW5G22%2Bjvun6ZZKuEDCID%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQARoMNTUzNjk5ODI2MjMwIgwQiRvziaD4iV2aP5AqtQPBu3VT%2B6RagGwmeI7kjweJFKGJu9z62i9hrZKeezCYWiAy19BmJcROgi3TUfIuQBPUkOej%2BgLz1IEBqrZFZ3%2BovRKVKJAk9w1JaNRJ52mKkhxQk59oi8jw3SJV%2Fy83eFaijHmTOmceIerJKFyJrO%2FzTHQA65g9BOeSGp4v%2FLiQ8YG4dRexBEUNJrHuDHXbpw7teh2K3u70G8WSSos8GZjL2wcu0Je4QKIjgOnKih%2BoZxlZthP23tOMRTdKVnJq5yKWSCER3BtO%2FTHE4RWXuaOGuPjEz2fQZ7B1H0uu3V1aLAVhg7XMhgB7ZBVyMc1MFvKJ3VOsPenWOzOzPxyARcD%2F8%2FhplH4VMQaFffzH0hmtAp%2BpBRbwbSdKe6QUd9zr%2F%2B2rY7Exl7XQZ2et7arD9Z57SBYqytzq3FIpQa681BP5mHySZ0wTAGaZqTawnY6aaaYVnXY%2BHpao0OkFIgyyI9wlHOMIrCHo46r5gpuEz0kcXygcaJrouRkOBVqQcKlzEbzbWeVe7tMYjf%2FyZvDU06Ll1%2Fd6KDng3BlNbvd1yr0F%2BQyOVNDUtAU4HlG65uTF6vE%2BfWECYDCN9Iq5BjqfAfDBdssyG8MqXo%2FVgXkqwS7nQ365yWlB%2F0alSEaNA9BdxRn17u7VEqcytAIya8yYo%2B%2Fru5wWOzO8q%2FOrRkSMSmUk6CMgxDI2aSaTHmPU%2BzgxcVT%2Fl6PE69l649a%2F8PHeiiVxI6vlTe6RAQ%2BF7HELCTvWIKGLcP3algcHSeGe1K%2FsTsRAYdms4IN%2BUnh1UdTVfsakvVJEloroHGGMahX0Fw%3D%3D",
"presigned_url_valid_until": "2024-10-30T23:08:26.498414639+00:00",
"size_kb": 1227644
},
{
"asset_type": "best_frame",
"mime_type": "image/bmp",
"presigned_url": "https://authchallenge-staging-bas-tempchallengeassetsf1ee3-hmpcce3mhwpk.s3.ap-southeast-2.amazonaws.com/challenge_01JBFTCSEJE4G9XB7T4PVJQR04/auth_32897196-0b36-4e0e-a769-eecc8767f9e1/frame-0006-auth_32897196-0b36-4e0e-a769-eecc8767f9e1.bmp?x-id=GetObject&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAYB2YU3I3AKUD7YCG%2F20241030%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20241030T225826Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=18052fa63cf35942facac95ae47d1d0b1e9c65a8b24db449fc074cbf59abdbc3&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAcaDmFwLXNvdXRoZWFzdC0yIkYwRAIgPxfTZfDIU3hSyIweH4Pr%2FdQbMMucMC%2BnSXj1lkSWBJYCIFcv%2FA0uHGigSLRUDcGrJ98KZPbQZHMW5G22%2Bjvun6ZZKuEDCID%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQARoMNTUzNjk5ODI2MjMwIgwQiRvziaD4iV2aP5AqtQPBu3VT%2B6RagGwmeI7kjweJFKGJu9z62i9hrZKeezCYWiAy19BmJcROgi3TUfIuQBPUkOej%2BgLz1IEBqrZFZ3%2BovRKVKJAk9w1JaNRJ52mKkhxQk59oi8jw3SJV%2Fy83eFaijHmTOmceIerJKFyJrO%2FzTHQA65g9BOeSGp4v%2FLiQ8YG4dRexBEUNJrHuDHXbpw7teh2K3u70G8WSSos8GZjL2wcu0Je4QKIjgOnKih%2BoZxlZthP23tOMRTdKVnJq5yKWSCER3BtO%2FTHE4RWXuaOGuPjEz2fQZ7B1H0uu3V1aLAVhg7XMhgB7ZBVyMc1MFvKJ3VOsPenWOzOzPxyARcD%2F8%2FhplH4VMQaFffzH0hmtAp%2BpBRbwbSdKe6QUd9zr%2F%2B2rY7Exl7XQZ2et7arD9Z57SBYqytzq3FIpQa681BP5mHySZ0wTAGaZqTawnY6aaaYVnXY%2BHpao0OkFIgyyI9wlHOMIrCHo46r5gpuEz0kcXygcaJrouRkOBVqQcKlzEbzbWeVe7tMYjf%2FyZvDU06Ll1%2Fd6KDng3BlNbvd1yr0F%2BQyOVNDUtAU4HlG65uTF6vE%2BfWECYDCN9Iq5BjqfAfDBdssyG8MqXo%2FVgXkqwS7nQ365yWlB%2F0alSEaNA9BdxRn17u7VEqcytAIya8yYo%2B%2Fru5wWOzO8q%2FOrRkSMSmUk6CMgxDI2aSaTHmPU%2BzgxcVT%2Fl6PE69l649a%2F8PHeiiVxI6vlTe6RAQ%2BF7HELCTvWIKGLcP3algcHSeGe1K%2FsTsRAYdms4IN%2BUnh1UdTVfsakvVJEloroHGGMahX0Fw%3D%3D",
"presigned_url_valid_until": "2024-10-30T23:08:26.498592223+00:00",
"size_kb": 921654
}
],
"events":
[
{
"name": "consent_given",
"timestamp": "2024-10-30T22:58:07.550Z"
}
],
"initiated_at": "2024-10-30T22:58:04.375Z",
"flow_behaviour":
{},
"flow_style":
{
"body_text_colour_hex": "#000000",
"header_text_colour_hex": "#000000",
"logo_public_url": "https://corporate.mcdonalds.com/content/dam/sites/corp/nfl/newsroom/Golden%20Arches.png",
"primary_colour_hex": "#000000",
"show_consent_checkbox": true,
"terms_of_service_url": "https://example.com/privacy-policy"
}
}
| Field | Description |
|---|---|
challenge_id | An identifier for the authentication challenge. |
customer_reference | An optional field that you can pass in the request, often used to carry an identifying value. |
created_at | The date and time when the authentication was created. |
expired_at | The date and time when the authentication is expired. |
status | The current status of the authentication. open, complete or expired. |
closed_reason | The reason why the authentication challenge was closed. |
consent_required | Whether the user's consent is required. |
consent_given_at | The date and time when the consent was given. |
overall_result | The overall authentication result is either PASSsuccessful or FAIL unsuccessful authentication. |
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. It contains the liveness_featid, compared_to_image or compared_to_featids depending on the type of challenge that was created. |
assets_links | The temporary links that allow access to assets related to the authentication process. Please refer to the table below for details. |
events | The array of authentication event objects. |
initiated_at | The date and time when the authentication was initiated. |
flow_behaviour | The flow behaviour object. |
flow_style | The visual and style configurations of the authentication flow. - primary_colour_hex: The primary colour using a valid HEX colour code (e.g., #ffffff).- header_text_colour_hex: The colour of the header text within the challenge using a valid HEX colour code (e.g., #ffffff).- body_text_colour_hex: The colour of the body text using a valid HEX colour code (e.g., #ffffff).- logo_public_url: A logo URL.- terms_of_service_url: The URL for the terms of service.- show_consent_checkbox: Indicates whether a consent checkbox should be displayed to users. |
1. liveness_result Object
liveness_result Object| Field | 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. |
2. assets_links Object
assets_links Object| Field | 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. |
3. events Object
events Object| Field | Description |
|---|---|
name | The name of an event that occurred during authentication. |
timestamp | The date and time when the event occurred. |
4. flow_behaviour Object
flow_behaviour Object| Field | Description |
|---|---|
exit_redirect_url | The URL where the user will be redirected when the authentication is complete. |
5. flow_style Object
flow_style Object| Parameter | Description |
|---|---|
primary_colour_hex | The primary colour in Hex (e.g., #ffffff). |
header_text_colour_hex | The colour 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. |
Info:
The above result and tables are for a sample result from the authentication process with liveness only. Please note that the result can vary depending on the type of challenge you have created.
See Check Authentication Status for different results.
📌 Need Help?
