Usage
This API is designed to retrieve the spot check result.
Base URL by Region
The base URL you should use depends on the region where your services are hosted. Below are the available URLs for each region. By default, the EU region URL is used.
- EU (Default): https://api.idwise.com/
- UAE: https://api-uae.idwise.com/
- Qatar: https://api-qat.idwise.com/
Authentication
Please refer to the lease refer to the API Credentials and Authentication page for more detailed information
API Response Description
The response has the following structure.
{
"journey_id": "",
"tenant_id": "",
"environment_name": "",
"start_time": "",
"end_time": "",
"system_decision": null,
"reference_number": "",
"model_version": null,
"selfie": {SelfieModel},
"applicant": {ApplicantModel},
"rule_results": {"rule_id": RuleResultModel},
"spot_checks": {SpotchecksModel}
}
Property | Description |
---|---|
journey_id | Type: |
tenant_id | Type: |
start_time | Type: |
end_time | Type: |
reference_number | Type: |
environment_name | Type: |
** ** | Type: |
model_version | Type: |
Type: | |
Type: | |
**Type: ** Check the following section for detailed information about the applicant object. | |
**Type: ** |
System Decision Enum
Enum Value | Description |
---|---|
Incomplete | The journey is not completed yet so a decision cannot be drawn yet. |
Complete | The journey was successfully completed and passed all configured checks and rules. If the journey status is marked as Complete , it should be considered as passed. |
Refer | The journey was completed but has failed one or more of the configured checks or rules. |
Selfie Model
Property | Description |
---|---|
status | **Type: ** |
is_live | **Type: ** |
liveness_status_code | **Type: ** refer to the list of all possible error codes available for your reference. |
image_path | **Type: ** to download the image. |
video_path | Type: to download the video |
Liveness Status Codes
Code | Description |
---|---|
FACE_TOO_CLOSE | Face is too close to camera. |
FACE_CLOSE_TO_BORDER | Face is too close to the border of the image. |
FACE_CROPPED | Face is cropped, and can be reduce the accuracy of the liveness detection because the face is not complete. |
FACE_IS_OCCLUDED | Part of the face is covered by mask or another objects and it can reduce accuracy of the liveness detection. |
FACE_NOT_FOUND | Failed to detec a face. |
TOO_MANY_FACES | Too many faces detected. |
FACE_TOO_SMALL | The face area is not big enough to do the face liveness analysis. |
BAD_QUALITY_IMAGE | Image quality is too low for accurate analysis, possibly due to low resolution or blurring. |
FACE_ANGLE_TOO_LARGE | The face is tilted or rotated beyond acceptable angles for reliable analysis. |
NOT_LIVE | The ML model determined that the face does not appear to be live. |
Rule Result Model
This object contains the rules will be run part of the spot check, this object contains only one rule for selfie liveness.
"rule_results": {
"selfie_liveness": {
"name": "Selfie Liveness",
"result": "Passed",
"description": "Verifies that the selfie photo supplied in the onboarding journey is live.",
"information": "This check verifies that the selfie photo captured in the selfie step of the onboarding journey is live and of an applicant that is physically present during the verification process.",
"tips": "If this check fails, check the selfie photo provided by the applicant.",
"details": [
RuleResultDetailsModel
]
}
}
Property | Description |
---|---|
selfie_liveness | **Type: ** |
name | **Type: ** |
result | **Type: ** |
description | **Type: ** |
information | **Type: ** |
tips | **Type: ** |
details | **Type: ** |
Rule Result Details Model
Here is a sample object for the rule result details model, check the table below for more detailed information:
{
"title": "Selfie",
"result": "Passed",
"result_description": "Selfie photo appears to be live.",
"reference_object": {
"object_key": "selfie",
"instance_key": "0"
}
}
Property | Description |
---|---|
title | the title of the check that presents the name of the document and the side to which the rule was applied against. |
result | the result of the check it can be either |
result_description | A tailored description massage for each result status. |
reference_object | Shows the related object for the check. Where it has 2 keys:
|
Applicant Field Model
Contains general information for the applicant.
Property | Description |
---|---|
applicant_id | **Type: ** |
profile_image_path | **Type: ** |
full_name | **Type: ** |
personal_number | **Type: ** |
birth_date | **Type: ** |
Spot Checks Model
Contains the results of the face match check between the onboarding journey and the current spot check journey.
{
"applicant_selfie_face_match": {
"is_matched": false,
"score": 0,
"images": [
{
"image_path": "1b7194bcf77d8be7541ddb6978e93f35",
"image_source": "Selfie"
},
{
"image_path": "55dd308d6b50905de04c19a8f1414d20",
"image_source": "Applicant"
}
]
}
Property | Description |
---|---|
is_matched | Type: |
score | Type: |
image_path | **Type: ** to download the image. |
images |
|