Retrieve Results of the Person's Image and "Live" Image Video

/aivpersonvrfy

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

info

This method will retrieve the result for a specific /aivpersonvrfy POST request submitted previously.

• For synchronous interaction mode ( mode is “SYNC” ), this method can be used to get the result of the earlier submitted POST request if the request has been terminated prematurely before the return of a response;
• For asynchronous interaction mode ( mode is “ASYNC” ), this method be used to get the result of the earlier submitted POST request after waiting for specific interval.

Request

Request Parameters

Field Name	Required	Type	Length	Description	Example
source	Yes	String	16	Source.	"FNXCRDS"
partnerId	Yes	String	128	Partner ID.	"BSSS"
productType	Optional	String	128	Product type.	"appTest"
reference	Yes	String	64	Reference.	"ID00000213132"
apiKey	Conditional	String	64	API key.	"1233214HSC"
apiVersion	Yes	String	8	API version.	"1.6"
referenceId	Yes	String	64	Reference ID.	"272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw"
language	Optional	String	2	Language.	"en","ms"

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.	AIVPersonVrfyGetResponse
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	Length	Description	Example
status	Yes	Object		Status.	Refer to explanation below.
payload	Optional	Object		Field layout of the earlier CDD Post Response.	Refer to explanation below.

Object: status

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

Object: sourceInfo

Field Name	Required	Type	Length	Description	Example
source	Yes	String	16	Source.	"FNXCRDS"
partnerId	Yes	String	128	Partner ID.	"BSSS"
productType	Optional	String	128	Partner type.	"appTest"
reference	Yes	String	64	Reference.	"ID00000213132"
apiVersion	Yes	String	8	API version.	"1.6"
apiKey	Conditional	String	64	API key.	"1233214HSC"
userId	Optional	String	32	User ID.	"mkchan"
userToken	Optional	String	64	User token.	"APPOKJSID8J1234"

Object: errorList

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

Object: payload

Field Name	Required	Type	Length	Description	Example
status	Yes	Object		Status	Refer to explanation below.
payload	Yes	Object		Information from the resemblance test.	Refer to explanation below.

Object: status

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

Object: sourceInfo

Field Name	Required	Type	Length	Description	Example
source	Yes	String	16	Source.	"FNXCRDS"
partnerId	Yes	String	128	Partner ID.	"BSSS"
productType	Optional	String	128	Partner type.	"appTest"
reference	Yes	String	64	Reference.	"ID00000213132"
apiVersion	Yes	String	8	API version.	"1.6"
apiKey	Conditional	String	64	API key.	"1233214HSC"
userId	Optional	String	32	User ID.	"mkchan"
userToken	Optional	String	64	User token.	"APPOKJSID8J1234"

Object: errorList

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

Object: payload

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

Object: bestImageFrame

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

Example Message

Request

/aivpersonvrfy GET Request

curl -X GET "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivpersonvrfy?source=FNXCRDS&partnerId=BSSS&productType=appTest&reference=ID00000213132&apiVersion=1.6&referenceId=272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw&apiKey=1233214HSC" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \ 

Response

/aivpersonvrfy GET Response

{
   "status": {
      "sourceInfo": {
           "reference": "ID00000213132",
           "apiVersion": "1.6",
           "apiKey": "1233214HSC",
           "source": "FNXCARDS",
           "partnerId": "BSSS"
           "productType": "appTest"
         "referenceId": "272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw",
         "language": "en"
      },
      "errorList": [
           {
              "msgText": "",
              "msgCode": ""
           }
      ],
      "status": "SUCCESS"
   },
   "payload": {
      "status": {
           "sourceInfo": {
              "reference": "ID00000213132",
              "apiVersion": "1.6",
              "apiKey": "1233214HSC",
              "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"

           }
      }
   }
}