Check a Person
/checkpersoncdd
Method : POST
URL : https://xxx.finexusgroup.com/acdd/rest/v1/checkpersoncdd
info
This method allows the submission of a request to check whether to admit a Person as customer in accordance to the stipulated CDD rules.
The response will include:
- A recommendation on whether to accept the Person as customer.
- The evaluation of CDD rules which led to the recommendation.
- Any negative reference reports used in the evaluation is available for retrieval.
- Request
- Response
Request Parameters
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
sourceInfo | Yes | Object | Source info. | Refer to explanation below. | |
interactionMode | Yes | Object | Interaction mode. | Refer to explanation below. | |
language | Optional | String | 2 | Language. | "en","ms" |
purpose | Yes | String | 128 | Purpose. | "BASIC","ENHANCE" |
applicantName | Yes | Object | Applicant name. | Refer to explanation below. | |
nationality | Yes | String | 2 | Nationality. | "SG" |
idDoc | Yes | Object | ID document. | Refer to explanation below. | |
dob | Yes | String | 16 | Date of birth. | "1975-01-25" |
gender | Yes | String | 2 | Gender. | "M","F" |
email | Optional | String | 256 | Email. | "mkchan88@gmail.com" |
race | Optional | String | 64 | Race. | "Chinese" |
address | Optional | Object | Address. | Refer to explanation below. | |
pob | Optional | Object | Place of birth. | Refer to explanation below. | |
homeTelNo | Optional | String | 16 | Home telephone number. | "28760941" |
officeTelNo | Optional | String | 16 | Office telephone number. | "28760941" |
mobileNo | Optional | String | 16 | Mobile telephone number. | "28760941" |
employment | Optional | Object | Employment details. | Refer to explanation below. | |
bankInfo | Optional | Object | Bank 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: applicantName
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
fullName | Yes | String | 128 | Full name. | "Hector Rafael" |
givenName | Optional | String | 128 | Given name. | "Hector" |
familyName | Optional | String | 128 | Family name. | "Rafael" |
aliases | Optional | String | 128 | Aliases. | "Hector" |
Object: idDoc
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
idType | Yes | String | 32 | ID type. | "MYKAD","PASSPORT","UNID","BCREGNO" |
idNo | Yes | String | 32 | ID number. | "1234567890" |
issuedByCountry | Optional | String | 2 | Issued by country. | "MX" |
issuedDate | Optional | String | 16 | Issued date. | "2016-03-15" |
expiryDate | Optional | String | 16 | Expiry date. | "2021-03-15" |
Object: address
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
addrLine1 | Yes | String | 256 | Address line 1. | "No 1 Jalan Manis" |
addrLine2 | Optional | String | 256 | Address line 2. | "Taman Madu" |
addrLine3 | Optional | String | 256 | Address line 3. | "KL" |
city | Yes | String | 128 | City. | "Kuala Lumpur" |
state | Yes | String | 128 | State. | "Selangor" |
country | Yes | String | 2 | Country. | "SG" |
postcode | Yes | String | 16 | Postal code. | "50200" |
Object: pob
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
addrLine1 | Yes | String | 256 | Address line 1. | "No 1 Jalan Manis" |
addrLine2 | Optional | String | 256 | Address line 2. | "Taman Madu" |
addrLine3 | Optional | String | 256 | Address line 3. | "KL" |
city | Yes | String | 128 | City. | "Kuala Lumpur" |
state | Yes | String | 128 | State. | "Selangor" |
country | Yes | String | 2 | Country. | "SG" |
postcode | Yes | String | 16 | Postal code. | "50200" |
Object: employment
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
employmentType | Yes | String | 128 | Employment type. | "Employed","Self-employed","Unemployed" |
position | Optional | String | 128 | Position. | "Executive" |
income | Optional | String | 12 | Income. | "2500" |
duration | Optional | String | 9 | Duration. | "2.5" |
employer | Optional | Object | Employer. | Refer to explanation below. |
Object: employer
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
legalForm | Yes | String | 2 | Legal form. | "HSBC0222" |
legalName | Yes | String | 128 | Legal name. | "Berjaya Starbuicks Sdn Bhd" |
bizName | Optional | String | 128 | Business name. | "Starbuicks Tea" |
bizType | Yes | String | 32 | Business type. | "Private Limited Company" |
idNo | Yes | String | 32 | ID number. | "948649-V" |
mcc | Conditional | String | 4 | Merchant Category Code. | "5812" |
countryDomicile | Optional | String | 2 | Country Domicile. | "SG" |
address | Yes | Object | Address. | "Refer to explanation below." | |
pic | Yes | Object | Person-in-charge. | "Refer to explanation below." |
Object: address
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
addrLine1 | Yes | String | 256 | Address line 1. | "No 1 Jalan Manis" |
addrLine2 | Optional | String | 256 | Address line 2. | "Taman Madu" |
addrLine3 | Optional | String | 256 | Address line 3. | "KL" |
city | Yes | String | 128 | City. | "Kuala Lumpur" |
state | Yes | String | 128 | State. | "Selangor" |
country | Yes | String | 2 | Country. | "SG" |
postcode | Yes | String | 16 | Postal code. | "50200" |
Object: pic
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
fullName | Yes | String | 128 | Full name. | "Hector Rafael" |
givenName | Optional | String | 128 | Given name. | "Hector" |
familyName | Optional | String | 128 | Family name. | "Rafael" |
aliases | Optional | String | 128 | Aliases. | "Hector" |
Object: bankInfo
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
bankCode | Yes | String | 16 | Bank code. | "HSBC0222" |
accountNo | Optional | String | 32 | Account number. | "1340295020304" |
accountName | Optional | String | 128 | Account name. | "Chan Mun Kit" |
ownership | Optional | String | 1 | Ownership. | "I","J" |
Response Codes
Response Code | Description | Response Schema |
---|---|---|
200 | Allow. | CDDPostResponse |
400 | Bad request. | NIL |
401 | Unauthorised access. | NIL |
405 | Forbidden access. | NIL |
Response Parameters
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 |
---|---|---|---|---|---|
msgCode | Yes | String | 9 | Message code. | "000" |
msgText | Yes | String | 128 | Message text. | "Missing Parameter" |
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 POST Request
curl -X POST "https://xxx.finexusgroup.com/ACDD/rest/v1/checkpersoncdd" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"sourceInfo": {
"source": "FNXCRDS",
"partnerId": "BSSS",
"productType": "Credit Card",
"reference": "2003160192931",
"apiVersion": "1.2",
"apiKey": "123-KEJRU-001",
"userId": "mkchan",
"userToken": "APPOKJSID8J1234"
},
"interactionMode": {
"mode": "SYNC",
"callbackURL": "www.abc.com"
},
"language": "en",
"purpose": "ENHANCE",
"applicantName": {
"fullName": "Hector Rafael",
"givenName": "Hector",
"familyName": "Rafael",
"aliases": ["Hector"]
},
"idDoc": {
"idType": "MYKAD",
"idNo": "1234567890",
"issuedByCountry": "MX",
"issuedDate": "2016-03-15",
"expiryDate": "2021-03-15"
},
"nationality": "SG",
"dob": "1975-01-25",
"gender": "M",
"race": "Chinese",
"email": "mkchan88@gmail.com",
"address": {
"addrLine1": "No 1 Jalan Manis",
"addrLine2": "Taman Madu",
"addrLine3": "KL",
"city": "Kuala Lumpur",
"state": "Selangor",
"country": "SG",
"postcode": "50200"
},
"pob": {
"addrLine1": "No 1 Jalan Manis",
"addrLine2": "Taman Madu",
"addrLine3": "KL",
"city": "Kuala Lumpur",
"state": "Selangor",
"country": "SG",
"postcode": "50200"
},
"homeTelNo": "28760941",
"officeTelNo": "28760941",
"mobileNo": "28760941",
"employment": {
"employmentType": "Employed",
"position": "NRIC",
"duration": "2.5",
"income": "2500",
"employer": {
"legalForm": "HSBC0222",
"legalName": "Berjaya Starbuicks Sdn Bhd",
"bizName": "Starbuicks Tea",
"bizType": "Private Limited Company",
"idNo": "948649-V",
"mcc": "5812",
"countryDomicile": "SG",
"address": {
"addrLine1": "No 1 Jalan Manis",
"addrLine2": "Taman Madu",
"addrLine3": "KL",
"city": "Kuala Lumpur",
"state": "Selangor",
"country": "SG",
"postcode": "50200"
},
"pic": {
"fullName": "Hector Rafael",
"givenName": "Hector",
"familyName": "Rafael",
"aliases": ["Hector"]
}
}
},
"bankInfo": {
"bankCode": "HSBC0222",
"accountNo": "1340295020304",
"accountName": "Chan Mun Kit",
"ownership": "I"
}
}
'
/checkpersoncdd POST 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": "u125",
"userToken": "Cb1sci18j2UvNLsq4"
},
"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
}
}
}