Login to AIV

/aivlogin

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

info

• This method allows the submission of a request from eKYC’s web app for an apiKey to Log into the AIV system using encrypted message that have been signed by the Host.
• licenseKey to be provided by Finexus.

Request

Request Parameters

Field Name	Required	Type	Length	Description	Example
sourceInfo	Yes	Object		Source information.	Refer to explanation below.
interactionMode	Yes	Object		Interaction mode.	Refer to explanation below.
contextInfo	Yes	Object		Context information.	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: interactionMode

Field Name	Required	Type	Length	Description	Example
mode	Yes	String	8	Mode.	"SYNC", "ASYNC"
callbackUrl	Optional	String	256	Callback URL.

Object: contextInfo

Field Name	Required	Type	Length	Description	Example
ctxSourceInfo	Yes	Object		Context source information.	Refer to explanation below.
licenseKey	Yes	String	27	License key.	"ASJ123412"
ctxDateTime	Yes	String	14	Context date time.	"2203161000699"
purpose	Yes	String	50	Purpose.	"Test"
signature	Yes	String	999	Signature. Appendix 1	"4C3ACE806CD5F"

note

ctxSourceInfo, licenseKey, ctxDateTime and purpose fields are required for signing.

Object: ctxSourceInfo

Field Name	Required	Type	Length	Description	Example
source	Yes	String	16	Source.	"FNXCRDS"
partnerId	Yes	String	128	Partner ID.	"BSSS"

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.	AIVLoginResponse
400	Bad request whereby the service cannot find the message layout as expected.	NIL
401	Unauthorised access - unable to authenticate source system	NIL
405	Forbidden access - source system is not authorised to perform an action	NIL

Response Parameters

Field Name	Required	Type	Length	Description	Example
status	Yes	Object		Status.	Refer to explanation below.
payload	Optional	Object		AIV login information.	Refer to explanation below.

Object: status

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

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.
msgText	Yes	String	128	Message text.

Object: payload

Field Name	Required	Type	Length	Description	Example
apiKey	Yes	String	256	API key.	"1233214HSC"

Example Message

Request

/aivlogin POST Request

curl -X POST "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivlogin" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \ 
 -d '{
        "sourceInfo": {
            "source": "test",
            "partnerId": "test",
            "apiVersion": "1.6",
            "reference": "ID00000213132",
        },
        "interactionMode": {
            "mode": "async"
        },
        "contextInfo": {
            "licenseKey": "ASJ123412",
            "ctxDateTime": "20211201083010",
            "purpose": "Test",
            "ctxSourceInfo": {
                "source": "FNXCRDS",
                "partnerId": "PR"
            },
            "signature": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        }
    }'

Response

/aivlogin POST Response

{   
"status": {
        "sourceInfo": {
            "source": "test",
            "partnerId": "test",
            "apiVersion": "1.6",
            "reference": "ID00000213132",
            "apiKey": "1233214HSC"
        },
        "errorList": [
                {
                       "msgText": "",
                       "msgCode": ""
                }
            ],
        "status": "SUCCESS"
    },
    "payload": {
        "apiKey": "1233214HSC"
    },
}