Retrieve a Person's Results
/checkpersoncdd
Method : GET
URL : https://xxx.finexusgroup.com/acdd/rest/v1/checkpersoncdd
info
This method will retrieve the CDD result for a specific /checkpersoncdd POST request submitted previously.
- For a synchronous interaction mode (
mode
is “SYNC” ), this method can be used to get the CDD result of the earlier submitted POST request if the request has been terminated prematurely before the return of a response; - For an asynchronous interaction mode (
mode
is “ASYNC” ), this method can be used to get the CDD result of the earlier submitted POST request after waiting for specific interval.
- Request
- Response
Request Parameters
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 | Unique reference number. | "2003160192931" |
referenceId | Yes | String | 64 | Reference ID. | "2003160192931" |
apiVersion | Yes | String | 8 | API version. | "1.2" |
language | Optional | String | 2 | Language. | "en","ms" |
apiKey | Optional | String | 64 | API key. | "123KEJRU001" |
Response Codes
Response Code | Description | Response Schema |
---|---|---|
200 | Allow. | CDDPostResult |
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 | CDD Post result. | 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: 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. | "BSSS01" |
reference | Yes | String | 64 | Reference. | "50074154501001" |
referenceId | Yes | String | 64 | Reference ID. | "50074154501001" |
apiVersion | Yes | String | 8 | API Version. | "1.2" |
apiKey | Conditional | String | 64 | API Key. | "123KEJRU001" |
Object: errorList
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
msgText | Yes | String | 8 | Message text. | "Report unsuccessfully retrieved." |
msgCode | Yes | String | 128 | Message code. | "404" |
Object: payload
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
status | Yes | Object | Status. | Refer to explanation below. | |
payload | Optional | Object | CDD result. | 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: 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. | "Report unsuccessfully retrieved." |
msgCode | Yes | String | 8 | Message code. | "404" |
Object: payload
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
highriskCountry | Yes | String | 2 | High-risk country. | "T","F" |
blacklistReport | Yes | String | 2 | Blacklist report. | "T","F" |
scReport | Yes | String | 2 | Securities Commissions report. | "T","F" |
maccReport | Yes | String | 2 | Malaysian Anti-Corruption Commissions report. | "T","F" |
bnmReport | Yes | String | 2 | Bank Negara Malaysia report. | "T","F" |
kdnReport | Yes | String | 2 | Kementerian Dalam Negeri report. | "T","F" |
unscReport | Yes | String | 2 | United Nations Security Council report. | "T","F" |
ofacReport | Yes | String | 2 | Office of Foreign Assets Control report. | "T","F" |
ctosReport | Yes | String | 2 | CTOS report. | "T","F" |
reasoning | Optional | Object | Reasoning. | Refer to explanation below. | |
recommendation | Yes | String | 1 | Recommendation. | "Accept","Reject","Manual" |
threshold | Optional | String | 4 | Threshold. | "49" |
riskScore | Optional | String | 4 | Risk score. | "10" |
Object: reasoning
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
rulesEvaluated | Yes | Object | Rules Evaluated. | Refer to explanation below. | |
reEvaluate | Yes | String | 1 | Reevaluate. | "T","F" |
Object: rulesEvaluated
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
result | Optional | String | 8 | Result. | "PASS","FAIL", "MANUAL", "Error" |
weight | Optional | String | 4 | Weight. | "0" |
ruleId | Optional | String | 16 | Rule ID. | "BLK01" |
ruleDescription | Yes | String | 128 | Rule description. | "Check for any blacklist reference" |
Example Message
- Request
- Response
/checkpersoncdd GET Request
curl -X GET "https://xxx.finexusgroup.com/ACDD/rest/v1/checkpersoncdd?source=FNXCRDS&partnerId=BSSS&productType=loanapplication&reference=2003160192931&apiVersion=1.3&referenceId=2003160192931&language=en&apiKey=123-KEJRU-001" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
/checkpersoncdd GET Response
{
"status":{
"sourceInfo":{
"source":"FNXCRDS",
"partnerId":"BSSS",
"productType":"BSSS01",
"reference":"50074154501001",
"apiVersion":"1.2",
"apiKey":"123KEJRU001",
"referenceId":"50074154501001"
},
"errorList":[
{
"msgText":"Report unsuccessfully retrieved.",
"msgCode":"404"
}
],
"status":"SUCCESS"
},
"payload":{
"status":{
"sourceInfo":{
"source":"FNXCRDS",
"partnerId":"BSSS",
"productType":"BSSS01",
"reference":"50074154501001",
"apiVersion":"1.2",
"apiKey":"123KEJRU001",
"userId":"mkchan",
"userToken":"APPOKJSID8J1234"
},
"errorList":[
{
"msgText":"Report unsuccessfully retrieved.",
"msgCode":"404"
}
],
"status":"SUCCESS"
},
"payload":{
"highriskCountry":"F",
"blacklistReport":"F",
"scReport":"F",
"maccReport":"F",
"bnmReport":"F",
"kdnReport":"F",
"unscReport":"F",
"ofacReport":"F",
"ctosReport":"F",
"reasoning":{
"rulesEvaluated":[
{
"result":"FAIL",
"weight":50,
"ruleId":"FATF01",
"ruleDescription":"Check for high-risk country"
},
{
"result":"FAIL",
"weight":50,
"ruleId":"BLK01",
"ruleDescription":"Check for any blacklist reference"
},
{
"result":"PASS",
"weight":0,
"ruleId":"SC01",
"ruleDescription":"Check for any security commission reports"
},
{
"result":"PASS",
"weight":0,
"ruleId":"MACC01",
"ruleDescription":"Check for any malaysian anti-corruption commission reports"
},
{
"result":"PASS",
"weight":0,
"ruleId":"BNM01",
"ruleDescription":"Check for any malaysian national bank reports"
},
{
"result":"PASS",
"weight":0,
"ruleId":"KDN01",
"ruleDescription":"Check for any ministry of home affairs reports"
},
{
"result":"FAIL",
"weight":25,
"ruleId":"UNSC01",
"ruleDescription":"Check for any united nation security council reports"
},
{
"result":"FAIL",
"weight":21,
"ruleId":"OFAC01",
"ruleDescription":"Check for any office of foreign assets control reports"
},
{
"result":"PASS",
"weight":15,
"ruleId":"PRE01",
"ruleDescription":"Check for pre-approval recommendation"
},
{
"result":"PASS",
"weight":0,
"ruleId":"CS01",
"ruleDescription":"Check for any CTOS reports"
}
],
"reEvaluate":"F"
},
"recommendation":"Accept",
"threshold":49,
"riskScore":0
}
}
}