🔍#7 BiometricTest

#7.1 Upload Selfie Image :

This API is to upload Selfie captured image to match it with national id image,

and to upload recorded video to check active and passive liveness.

post
Authorizations
Body
imagestringRequired

Base64 selfie image, this image is to check the passive liveness without any active user interacion.

naturalImageScorenumber · doubleOptional

Natural image score if exist, this score can be detected from front-end image detect component

Default: 0Example: 50.0
smileImageScorenumber · doubleOptional

Smile image score if exist, this score can be detected from front-end image detect component

Default: 0Example: 50.0
recordstring | nullableOptional

Base64 selfie or recorded video, this video is to check the active liveness with user interacions like magnifeye, smile, ....

Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/BiometricTest/UploadSelfieImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "image": "text",
  "naturalImageScore": "50.0",
  "smileImageScore": "50.0",
  "record": "text"
}
{
  "isSuccess": true,
  "message": "text",
  "data": {
    "customerId": "74c16994-a047-476c-bd23-963610cb6285",
    "photoMatched": "true",
    "photoMatchPercentage": "65",
    "detectedAge": "30",
    "detectedGender": "M"
  }
}

#7.2 Approve Biometric Test:

This API is to approve the result of matching and liveness.

post
Authorizations
Responses
200

Success

application/json
post
POST /Onboarding/api/v1/onboarding/BiometricTest/Approve HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 0
}

#7.3 Get Selfie Image :

This API is to get selfie image for the current request

Deprecated
get
Authorizations
Responses
200

Success

application/json
Responseobject
get
GET /Onboarding/api/v1/onboarding/BiometricTest/GetSelfieImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{}

#7.4 Get Document Portrait :

This API is to get national Id or passport cropped personal photo.

Deprecated
get
Authorizations
Responses
200

Success

application/json
Responseobject
get
GET /Onboarding/api/v1/onboarding/BiometricTest/GetDocumetPortraitImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{}
Previous#6 Passport ScanNext#8 Phone Info

Last updated