Download CTOS Report
/download-ctos
Method : GET
URL : https://xxx.finexusgroup.com/acdd/rest/v1/download-ctos
info
This method will download a Person or an Organisation’s CTOS Report used in an earlier /checkpersoncdd POST or /checkorgcdd POST request.
- 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" |
reportFormat | Optional | String | 4 | Report format. | "XML","JSON" |
language | Optional | String | 2 | Language. | "en","ms" |
apiKey | Yes | String | 64 | API key. | "123KEJRU001" |
Response Codes
Response Code | Description | Response Schema |
---|---|---|
200 | Allow. | CTOSReportResponse |
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 | Overall CTOS report. | 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. | "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 | 128 | Message text. | "Unsuccessful download." |
msgCode | Yes | String | 8 | Message code. | "404" |
Object: payload
Field Name | Required | Type | Length | Description | Example |
---|---|---|---|---|---|
rulesEvaluated | Yes | Object | Rules evaluated. | Refer to explanation below. | |
recommendation | Yes | String | 2 | Recommendation. | "Accept","Reject","Manual" |
threshold | Optional | Number | 4 | Threshold. | 33 |
riskScore | Optional | Number | 4 | Risk score. | 33 |
xmlReport | Conditional | String | 256 | XML report. | "https://xxx.finexusgroup.com/ACDD/rest/v1/report?source=XXX&referenceId=XXXXXXXXXXXXXXX&reportFormat=XML" |
jsonReport | Conditional | String | 256 | JSON report. | "https://xxx.finexusgroup.com/ACDD/rest/v1/report?source=XXX&referenceId=XXXXXXXXXXXXXXX&reportFormat=JSON" |
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
/download-ctos GET Request
curl -X GET "https://xxx.finexusgroup.com/ACDD/rest/v1/download-ctos?source=FNXCRDS&partnerId=bsss&productType=loanapplication&reference=2003160192931&referenceId=2003160192931&apiVersion=1.3&reportFormat=XML&language=en&apiKey=123-KEJRU-001" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
/download-ctos GET Response
{
"status": {
"sourceInfo": {
"source": "FNXCRDS",
"partnerId": "BSSS",
"productType": "BSSS01",
"reference": "50074154501001",
"apiVersion": "1.3",
"apiKey": "123XXXXXX001",
"referenceId": ""
},
"errorList": [
{
"msgText": "",
"msgCode": ""
}
],
"status": "SUCCESS"
},
"payload": {
"ctosReport": "<xml></xml>"
}
}