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

/aivimageretrieval

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

info

This method will retrieve the images posted in an earlier /aivpersonidtfy POST request and the video posted in an earlier /aivpersonvrfy.

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"

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.	AivImageRetrieval
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		Information of the result.	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
images	Yes	Object		Image details.	Refer to explanation below.
video	Yes	Object		Video details.	Refer to explanation below.

Object: images

Field Name	Required	Type	Length	Description	Example
imageFront	Yes	Object		Front image content of the ID document.	Refer to explanation below.
imageBack	Conditional	Object		Back image content of the ID document.	Refer to explanation below.

Object: imageFront

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"

Object: imageBack

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"

Object: video

Field Name	Required	Type	Length	Description	Example
holderFaceVideo	Yes	Object		"Live" video content of the applicant's face.	Refer to explanation below.

Object: holderFaceVideo

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

Example Message

Request

/aivimageretrieval GET Request

curl -X GET "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivimageretrieval?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

/aivimageretrieval GET Response

{
    "status": {
        "sourceInfo": {
            "reference": "ID00000213132",
            "apiVersion": "1.6",
            "apiKey": "1233214HSC",
            "source": "AYP",
         "partnerId": "BSSS",
         "productType": "appTest"
        },
        "errorList": [
            "msgCode": "",
         "msgText": ""
        ],
        "status": "SUCCESS"
    },
    "payload": {
        "images": {
            "frontImage": {
                "image": "/9j/4AAQSkZJRgABAQAAAQABAAD",
                "contentMediaType": "image/jpeg",
                "contentEncoding": "base64"
            },
            "backImage": {
                "image": "",
                "contentMediaType": "",
                "contentEncoding": ""
            }
        },
        "video": {
            "holderFaceVideo": {
                "contentMediaType": "video/mp4",
                "contentEncoding": "base64",
                "video": "/9j/4AAQSkZJRgABAQAAAQABA"
            }
        }
    }
}