Upload Supporting Document

/aivpor

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

info

This method allows the submission of a request to upload an image or a PDF file as a supporting document to identify and verify a person.

The response will include the reference ID of the request so that the document will be able to be retrieved later on.

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"
fullName	Yes	String	Full name.	"James Smith"
mobileNo	Yes	String	Mobile number.	"0128123456"
address	Yes	Object	Address.	Refer to explanation below.
docData	Yes	Object	Document data.	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: address

Field Name	Required	Type	Description	Example
addrLine1	Yes	String	Address line 1.	"No.1, Jalan Manis"
addrLine2	Optional	String	Address line 2.	"Jalan Pangkor"
addrLine3	Optional	String	Address line 3.
city	Yes	String	City.	"Kuala Lumpur"
state	Yes	String	State.	"Wilayah Persekutuan Kuala Lumpur"
country	Conditional	String	Country code.
postcode	Yes	Numeric	Postcode.	"50000"

Object: docData

Field Name	Required	Type	Description	Example
contentEncoding	Yes	String	Encoding format of the document.	"base64"
contentMediaType	Yes	String	Media type of the document data.	"PDF"
image	Yes	String	Entire document data.	"iVBORw0KGgoAAAANSUhEUgAAApkAAAG"
documentType	Yes	String	Document type.	"Water Bill"

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.	DocumentDetails
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	Information of the result.	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
contentEncoding	Yes	String	Encoding format of the document.	"base64"
contentMediaType	Yes	String	Media type of the document data.	"PDF"
image	Yes	String	Entire document data.	"iVBORw0KGgoAAAANSUhEUgAAApkAAAG"
documentType	Yes	String	Document type.	"Water Bill"

Example Message

Request

/aivpor POST Request

curl -X POST "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivpor" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \ 
 -d '{
        "sourceInfo": {
            "source": "FNXCRDS",
            "partnerId": "BSSS",
            "reference": "220610181940",
            "apiVersion": "1.6",
            "apiKey": "123KUJR003",
            "productType": "Card application",
            "userId": "mkchan",
            "userToken": "APPOKJSID8J1234"
        },
        "interactionMode": {
            "mode": "SYNC",
            "callBackUrl": ""
        },
        "language": "en",
        "fullName": "James Smith",
        "mobileNo": "0128123456",
        "address": {
            "addrLine1": "No.1, Jalan Manis",
            "addrLine2": "Jalan Pangkor",
            "addrLine3": "",
            "city": "Kuala Lumpur",
            "state": "Wilayah Persekutuan Kuala Lumpur",
        "postcode": "50000"
        },
        "docData": {
            "documentType": "Water Bill",
            "contentMediaTye": "PDF",
            "contentEncoding": "BASE64",
            "document": "iVBORw0KGgoAAAANSUhEUgAAApkAAAG"
        }
    }'

Response

/aivpor POST Response

{
    "status": {
        "sourceInfo": {
            "source": "FNXCRDS",
            "partnerId": "BSSS",
            "reference": "220610181940",
            "apiVersion": "1.6",
            "apiKey": "123KUJR003",
            "productType": "Card application",
            "userId": "mkchan",
            "userToken": "APPOKJSID8J1234"
        },
        "errorList": [
            {
                "msgText": "",
                "msgCode": "000"
            }
        ],
        "status": "SUCCESS"
    },
    "payload": {
        "docData": {
            "documentType": "Water Bill",
            "contentMediaTye": "PDF",
            "contentEncoding": "BASE64",
            "document": "iVBORw0KGgoAAAANSUhEUgAAApkAAAG"
        }
    }
}