Submit the Person's "Live" Image Video

/aivpersonvrfy

Method : POST
URL : https://xxx.finexusgroup.com/AIV/rest/v1/aivpersonvrfy
Desc :

info

This service will check the resemblance of holder's "live" image video against holder’s image from ID document.

The inputs required for this request are as follows:

• The referenceId of the response for an earlier submitted /aivpersonidtfy POST request so that AIV retrieve the extracted image of the applicant from the ID document.
• The applicant submits a 3 - 5 seconds “live” video of the applicant face so that we can check against the applicant’s image extracted from the ID document.

The response will include:

• The assessment whether the applicant’s face from the “live” video bears any resemblance with the ID document’s image;
• The degree of resemblance expresses as a percentage and an image from the video which has the highest degree of resemblance.

Request

Request Parameters

Field Name	Required	Type	Description	Example
sourceInfo	Yes	Object	Source information.	Refer to explanation below.
interactionMode	Yes	Object	Interaction mode.	Refer to explanation below.
language	Optional	String	Language.	"en"
aivRefId	Yes	String	AIV reference ID.	"2003160192931"
holderFaceVideo	Yes	Object	"Live" video of the applicant's face.	Refer to explanation below.

Object: sourceInfo

Field Name	Required	Type	Description	Example
source	Yes	String	Source.	"FNXCRDS"
partnerId	Yes	String	Partner ID.	"BSSS"
productType	Optional	String	Partner type.	"appTest"
reference	Yes	String	Reference.	"2003160192931"
apiVersion	Yes	String	API version.	"1.6"
apiKey	Conditional	String	API key.	"123-KEJRU-001"
userId	Optional	String	User ID.	"mkchan"
userToken	Optional	String	User token.	"APPOKJSID8J1234"

Object: interactionMode

Field Name	Required	Type	Description	Example
mode	Yes	String	Mode.	"ASYNC"
callbackUrl	Optional	String	Callback URL.

Object: holderFaceVideo

Field Name	Required	Type	Description	Example
contentEncoding	Yes	String	Encoding format of the video.	"base64"
contentMediaType	Yes	String	Medium of the video data.	"mp4"
video	Yes	String	Entire video data.	"AAAAGGZ0eXBtcDQyA"

Response

Response Codes

Response Code	Description	Response Schema
200	The service is able to authenticate and allow the caller to use the service and method.	AIVPersonVrfyPostResponse
400	Bad request whereby the service cannot find the message layout as expected.	N/A
401	Unauthorised access - unable to authenticate source system	N/A
405	Forbidden access - source system is not authorised to perform an action	N/A

Response Parameters

Field Name	Required	Type	Description	Example
status	Yes	Object	Status	Refer to explanation below.
payload	Optional	Object	Result of the resemblance check between applicant’s face captured in a “live” video with the extracted image.	Refer to explanation below.

Object: status

Field Name	Required	Type	Description	Example
sourceInfo	Yes	Object	Source information.	Refer to explanation below.
status	Yes	String	Status.	"SUCCESS"
errorList	Yes	Object	Error list.	Refer to explanation below.

Object: sourceInfo

Field Name	Required	Type	Description	Example
source	Yes	String	Source.	"FNXCRDS"
partnerId	Yes	String	Partner ID.	"BSSS"
productType	Optional	String	Partner type.	"appTest"
reference	Yes	String	Reference.	"2003160192931"
apiVersion	Yes	String	API version.	"1.6"
apiKey	Conditional	String	API key.	"123-KEJRU-001"
userId	Optional	String	User ID.	"mkchan"
userToken	Optional	String	User token.	"APPOKJSID8J1234"

Object: errorList

Field Name	Required	Type	Description	Example
msgCode	Yes	String	Message code.	"000"
msgText	Yes	String	Message text.

Object: payload

Field Name	Required	Type	Description	Example
resembleFlg	Yes	String	Resemble flag.	"t"
degreeOfResemblance	Yes	Numeric	Degree of resemblance.	"100"
bestImageFrame	Yes	Object	Best image frame.	Refer to explanation below.

Object: bestImageFrame

Field Name	Required	Type	Description	Example
contentEncoding	Yes	String	Encoding format of the image.	"base64"
contentMediaType	Yes	String	Media type of the image data.	"jpeg"
image	Yes	String	Entire image data.	"/9j/4AAQSkZJRgABAQ"

Example Message

Request

/aivpersonvrfy POST Request

curl -X POST "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivpersonvrfy" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \ 
 -d '{
        "sourceInfo": {
                "reference": "205",
                "apiVersion": "1.6",
                "apiKey": "ABC1234567",
                "source": "FNXCARDS",
                "partnerId": "BSSS",
                "productType": "appTest",
                "userId": "mkchan",
                "userToken": "APPOKJJSIDJ1234"
        },
        "interactionMode": {
        "mode": "SYNC",
                "callbackUrl": ""
        },
        "language": "en",
        "aivRefId": "73",
        "holderFaceVideo": {
                "contentEncoding": "base64",
                "contentMediaType": "mp4",
                "video": "AAAAGGZ0eXBtcDQyA"
        }
    }'

Response

/aivpersonvrfy POST Request

{
   "status": {
      "sourceInfo": {
           "reference": "205",
           "apiVersion": "1.6",
           "apiKey": "ABC1234567",
           "source": "FNXCARDS",
         "partnerId": "BSSS",
           "productType": "appTest",
           "userId": "mkchan",
           "userToken": "APPOKJJSIDJ1234"
      },
      "errorList": [
           {
              "msgText": "",
              "msgCode": ""
           }
      ],
      "status": "SUCCESS"
   },
   "payload": {
      "resembleFlg": "t",
      "degreeofResemblance": 100,
      "bestImageFrame": {
           "image": "/9j/4AAQSkZJRgABAQ"
           "contentMediaType": "jpeg",
           "contentEncoding": "base64"
      }
   }
}