Login to ACDD

/login

Method : POST
URL : https://xxx.finexusgroup.com/acdd/rest/v1/login

info

This method allows the submission of a request for an apiKey to log into the ACDD system using encrypted message that have been signed by the Host.

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.
language	Optional	String	2	Language.	"en"
contextInfo	Yes	Object		Context info.	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	Yes	String	128	Product type.	"loanapplication"
reference	Yes	String	64	Reference.	"50074154501001"
apiVersion	Yes	String	8	API Version.	"1.2"
apiKey	Optional	String	64	API Key.	"123KEJRU001"
userId	Optional	String	32	User ID.	"u125"
userToken	Optional	String	64	User Token.	"Cb1sci18j2UvNLsq4"

Object: interactionMode

Field Name	Required	Type	Length	Description	Example
mode	Yes	String	8	Mode.	"SYNC","ASYNC"
callbackUrl	Optional	String	256	Call back URL.	"www.google.com"

Object: contextInfo

Field Name	Required	Type	Length	Description	Example
licenseKey	Yes	String		License Key.	"ASJ123412"
ctxDateTime	Yes	Object		Request date and time.	"2203161000699"
purpose	Yes	String	16	Purpose of the call.	"Test"
ctxSourceInfo	Yes	Object	16	Context Source Info.	Refer to explanation below.
signature	Yes	String	16	Signed encrypted message.	"^X{45}%"

Object: ctxSourceInfo

Field Name	Required	Type	Length	Description	Example
source	Yes	String	16	Source system.	"MXX"
partnerId	Yes	String	128	Customer code.	"BSSS"

Response

Response Codes

Response Code	Description	Response Schema
200	Allow.	CDDPostResponse
400	Bad request.	N/A
401	Unauthorised access.	N/A
405	Forbidden access.	N/A

Response Parameters

Field Name	Required	Type	Length	Description	Example
status	Yes	Object		Status.	Refer to explanation below.
payload	Optional	Object		Login response.	Refer to explanation below.

Object: status

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

Object: payload

Field Name	Required	Type	Length	Description	Example
apiKey	Yes	String	64	API Key.	"123KEJRU001"

Object: sourceInfo

Field Name	Required	Type	Length	Description	Example
source	Yes	String	16	Source.	"FNXCRDS"
partnerID	Yes	String	128	Partner ID.	"BSSS"
productType	Yes	String	128	Product type.	"loanapplication"
reference	Yes	String	64	Reference.	"50074154501001"
apiVersion	Yes	String	8	API Version.	"1.2"
apiKey	Optional	String	64	API Key.	"123KEJRU001"
userId	Optional	String	32	User ID.	"u125"
userToken	Optional	String	64	User Token.	"Cb1sci18j2UvNLsq4"

Object: errorList

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

Example Message

Request

/login POST Request

{
   "sourceInfo": {
      "source": "test",
      "partnerId": "test",
      "apiVersion": "1.3",
      "reference": "e19342b2e6074364bb51af270db71fa6Vc38TdFyPHcCEqg9",
      "productType": "testing"
   },
   "interactionMode": {
      "mode": "async"
   },
   "contextInfo": {
      "licenseKey": "ASJ123412",
      "ctxDateTime": "20211201083010",
      "purpose": "Test",
      "ctxSourceInfo": {
         "source": "FNXCRDS",
         "partnerId": "PR"
         },
         "signature": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      }
}

Response

/login POST Response

{   
"status": {
        "sourceInfo": {
            "source": "test",
            "partnerId": "test",
            "apiVersion": "1.3",
            "reference": "e19342b2e6074364bb51af270db71fa6V9",
            "productType": "testing"
        },
        "errorList": [
                {
                       "msgText": "",
                       "msgCode": ""
                }
            ],
        "status": "SUCCESS"
    },
    "payload": {
        "apiKey": "1F4ABF0D68F49A43A21C6C5F163CAB5"
    }
}