Comply_technical_integration_document.docx
This document was uploaded by user and they confirmed that they have the permission to share it. If you are author or own the copyright of this book, please report to us by using this DMCA report form. Report DMCA
Overview
Download & View Comply_technical_integration_document.docx as PDF for free.
More details
- Words: 1,601
- Pages: 27
TECHNICAL INTEGRATION DOCUMENT
Query Login URL: /user/authorize Method: POST Type: JSON Header: Authorization Value: Bearer •
Token will get when adding a new user from COMPLY web client.
Request Parameters Parameters username password
Type String String
Mandatory? Description Yes User name of login Yes Password of login
Sample “nabeel” “nabeel”
Response Parameters Parameter customerid status responsecode token
Type String String String String
Description Id of Customer User Status User response Token
Sample “6” “true” “Login Successfull” "eyJhbGciOiJSUzI1Ni IsInR5cCI6IkpXVCJ9. eyJicmFuY2giOiIwIi wiY29tcGFueSI6IjAiL CJleHAiOjE1MjgzMz M2NzMsInVzZXJpZC I6IjYiLCJ1c2VybmFtZ SI6Im5hYmVlbCJ9.B 7OMck1wYG0wOPzt W5yseFZwOVOy3W Zfub_eF96qpfopny2 N4NQwNb7X3N3P9 AMcEfYzIwKhNPsjD RjXfwsxyaHYbKQSYd c9zyKMwxyPI7wh5L 3yelCqCYYyGHto0dXLab28HRfO4vJk wAlNY_jiixk5y6wTwmL
1uu89qYTb8" Sample Request Body: { "username":"nabeel", "password":"nabeel" } Sample Response Body { "customerid":6, "status":"true", "responsecode":"Login Successfull", "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJicmFuY2giOiIwIiwiY29tcGFueSI6IjAiLCJleHAi OjE1MjgzMzM2NzMsInVzZXJpZCI6IjYiLCJ1c2VybmFtZSI6Im5hYmVlbCJ9.B7OMck1wYG0wOPztW 5yseFZwOVOy3WZfub_eF96qpfopny2N4NQwNb7X3N3P9AMcEfYzIwKhNPsjDRjXfwsxyaHYbKQS Ydc9zyKMwxyPI7wh5L3yelCqCYYyGHt-o0dXLab28HRfO4vJkwAlNY_jiixk5y6wTwmL1uu89qYTb8" }
Get All Policies URL: /risk/getallpolicies Method: GET Type: JSON Header: Authorization
Response Parameters Parameter id policyname company
Type String String String
isdefaultint
String
isdefault
String
isdeletedint
String
isdeleted
String
createdbyuserid
String
createdbyusername
String
createddate createdtime lasteditedbyuserid
String String String
lasteditedbyusername String lastediteddate
String
lasteditedtime
String
Description Id of policy Name of policy Company name of policy Check this policy defult (int) Check this policy defult yes or no Check this policy delete (int) Check this policy delete yes or no Id of policy created user Name of policy created user Policy created date Policy created time User id of last edited this policy Name of last edited this policy Date of last policy edited Time of last policy edited
Sample “13” “Al Mana Policy” “0” “0” “Yes” “0” “No” “0” "Admin" “2017-03-02” "05:49 PM" "0" "Admin" “2017-03-02” "05:49 PM"
Sample Response Body [ { "id":"13", "policyname":"Al Mana Policy", "company":"0", "isdefaultint":"1", "isdefault":"Yes", "isdeletedint":0, "isdeleted":"No", "createdbyuserid":"0", "createdbyusername":"Admin", "createddate":"2017-03-02", "createdtime":"05:49 PM", "lasteditedbyuserid":"0", "lasteditedbyusername":"Admin", "lastediteddate":"2018-05-17", "lasteditedtime":"03:58 PM" } ]
Update Default Policy URL: /risk/updatedefaultpolicy Method: POST Type: JSON Header: Authorization
Request Parameters Parameters policyid
Type String
Mandatory? Description Yes Id of policy
Sample “15”
Response Parameters Parameter status
Type String
Sample Request Body: { "policyid":"15" }
Sample Response Body:
true / false
Query Remittance Status URL: /risk/updatepolicystatus Method: POST Type: JSON
Description Status of updated policy True/False
Sample “True”
Header: Authorization
Response Parameters Parameter policyid status
Type String String
Description Id of policy If delete status(to activate) = 0 and if activate status(to delete) = 1
Sample “16” “1”
Description
Sample “:"1” “:"Customer” “:"0” “:"0” “:"0”
Sample Request: } "policyid":"16", "status":"1" } Sample Response Body: true / false
GET RISK DEFINITION URL: risk/getriskdefinition Method: GET Type: JSON Header: Authorization Action : read Form : newpolicy
Response Parameters Parameter id name parentid isendnode hasrelation
Type String String String String String
realtion text hasmonth descriptiontext operatorrelation Sample Response Body: [ { "id":"1", "name":"Customer", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"customer", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" } ]
String String String String String
“:"''” “:"customer” “:"0” “:"''” “:"”
GET RISK DEFINITION - TREE VIEW
URL: /risk/getriskdefinition Method: GET Type: JSON Header: Authorization action : "read" form : "newpolicy"
Response Parameters Parameter id name parentid isendnode hasrelation realtion text hasmonth
Type String String String String String String String String
descriptiontext operatorrelation
String String
Sample Response Body: [ { "id":"1", "name":"Customer", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"customer",
Description
Sample “2” "Product"
" 0" “0” "0" "''" "product" "0" "''" ""
"hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"2", "name":"Product", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"product", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"3", "name":"Jurisdiction", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"jurisdiction", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"4", "name":"Frequency", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"frequency", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"5", "name":"Volume", "parentid":"0", "isendnode":"0", "hasrelation":"0",
"realtion":"''", "text":"volume", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"6", "name":"Nationality", "parentid":"1", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"customernationality", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"7", "name":"IDType", "parentid":"1", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"customeridtype", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"8", "name":"Country", "parentid":"3", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"jurisdictioncountry", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"9", "name":"Service", "parentid":"2",
"isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"productservice", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"10", "name":"No.of Transactions", "parentid":"4", "isendnode":"1", "hasrelation":"0", "realtion":"''", "text":"frequencynooftransaction", "hasmonth":"1", "descriptiontext":"Frequency - No.of Transactions", "operatorrelation":"numeric" }, { "id":"11", "name":"Amount of Transaction", "parentid":"5", "isendnode":"1", "hasrelation":"0", "realtion":"''", "text":"volumeamountoftransaction", "hasmonth":"1", "descriptiontext":"Volume - Amount of Transaction", "operatorrelation":"numeric" }, { "id":"12", "name":"Name", "parentid":"6", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"customernationalityname", "hasmonth":"0", "descriptiontext":"Customer - Nationality Name", "operatorrelation":"variable" }, { "id":"13",
"name":"Currency", "parentid":"6", "isendnode":"1", "hasrelation":"1", "realtion":"currency", "text":"customernationalitycurrency", "hasmonth":"0", "descriptiontext":"Customer - Nationality Currency", "operatorrelation":"variable" }, { "id":"14", "name":"Is FATF", "parentid":"6", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"customernationalityisfatf", "hasmonth":"0", "descriptiontext":"Customer - Nationality IsFATF", "operatorrelation":"variable" }, { "id":"15", "name":"Type", "parentid":"7", "isendnode":"1", "hasrelation":"1", "realtion":"idtype", "text":"customeridtypetype", "hasmonth":"0", "descriptiontext":"Customer - ID Type", "operatorrelation":"variable" }, { "id":"16", "name":"Name", "parentid":"9", "isendnode":"1", "hasrelation":"1", "realtion":"service", "text":"productservicename", "hasmonth":"0", "descriptiontext":"Product - Service Name", "operatorrelation":"variable" },
{ "id":"17", "name":"Is Bank", "parentid":"9", "isendnode":"1", "hasrelation":"1", "realtion":"service", "text":"productserviceisbank", "hasmonth":"0", "descriptiontext":"Product - IsBank", "operatorrelation":"variable" }, { "id":"18", "name":"Is Fast Cash", "parentid":"9", "isendnode":"1", "hasrelation":"1", "realtion":"service", "text":"productserviceisfastcash", "hasmonth":"0", "descriptiontext":"Product - IsFastCash", "operatorrelation":"variable" }, { "id":"19", "name":"Is TT", "parentid":"9", "isendnode":"1", "hasrelation":"1", "realtion":"service", "text":"productserviceistt", "hasmonth":"0", "descriptiontext":"Product - IsTT", "operatorrelation":"variable" }, { "id":"20", "name":"Name", "parentid":"8", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"jurisdictioncountryname", "hasmonth":"0", "descriptiontext":"Jurisdiction - Country Name",
"operatorrelation":"variable" }, { "id":"21", "name":"Currency", "parentid":"8", "isendnode":"1", "hasrelation":"1", "realtion":"currency", "text":"jurisdictioncountrycurrency", "hasmonth":"0", "descriptiontext":"Jurisdiction - Country Currency", "operatorrelation":"variable" }, { "id":"22", "name":"Is FATF", "parentid":"8", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"jurisdictioncountryisfatf", "hasmonth":"0", "descriptiontext":"Jurisdiction - Country IsFATF", "operatorrelation":"variable" }, { "id":"33", "name":"Risk Category", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"riskcategory", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"34", "name":"Risk Score Settings", "parentid":"33", "isendnode":"1", "hasrelation":"0", "realtion":"''", "text":"riskscoresetting",
"hasmonth":"0", "descriptiontext":"Risk Score Setting", "operatorrelation":"riskscore" }, { "id":"40", "name":"Category", "parentid":"1", "isendnode":"1", "hasrelation":"0", "realtion":"''", "text":"customercategory", "hasmonth":"0", "descriptiontext":"Customer Category", "operatorrelation":"variable" }, { "id":"51", "name":"Is High Risk", "parentid":"6", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"customernationalityishighrisk", "hasmonth":"0", "descriptiontext":"Customer - Nationality Is High Risk", "operatorrelation":"variable" }, { "id":"52", "name":"Is High Risk", "parentid":"8", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"jurisdictioncountryishighrisk", "hasmonth":"0", "descriptiontext":"Jurisdiction - Country Is High Risk", "operatorrelation":"variable" } ]
GET NODE OPTIONS BY ID URL: /risk/getnodeoptionsbyid/id -eg:15/34 Method: GET Type: JSON Header: Authorization action : "read" form : "newpolicy"
Response Parameters Parameter QATAR ID PASSPORT COMMERCIAL REGISTRATION VISA COPY DIPLOMATIC ID DRIVING LICENSE
Type String String String
VISITING CUSTOMER
String
OTHER ID RP DC PP CR
String String String String String
String String String
Sample Response Body: [ "QATAR ID", "PASSPORT", "COMMERCIAL REGISTRATION", "VISA COPY", "DIPLOMATIC ID",
Description
Sample “QATAR ID” "PASSPORT" "COMMERCIAL REGISTRATION" “VISA COPY” "DIPLOMATIC ID" "DRIVING LICENSE" "VISITING CUSTOMER” "OTHER ID" "RP" 'DC” "PP" "CR"
"DRIVING LICENSE", "VISITING CUSTOMER", "OTHER ID", "RP", "DC", "PP", "CR" ]
GET NODE OPERATORS URL: /risk/getoperatorsbytype/operatorrelation -eg:variable/riskscore Method: GET Type: JSON Header: Authorization action : "read" form : "newpolicy"
Response Parameters Parameter id name type
Sample Response Body: [ { "id":"11", "name":"=",
Type String String String
Description
Sample “11” ":"=" "variable"
"type":"variable" } ]
Save New Policy URL: risk/saveriskpolicy Method: GET Type: JSON Header: Authorization action : create form : newpolicy
Response Parameters Parameter policyname numericrisksettings definition
Type String String String
Description
Sample “” " $2 " " 10 "
descriptiontext
String
“"Frequency -
definitiontext
String
No.of Transactions"” "frequencynooftransaction"
parentnode
String
“4”
fieldname1 fieldname2
String String
“0” “10”
operator1
String
“4”
operator1name
String
">"
operator2
String
“2”
operator2name
String
“<=”
value
String
“16”
noofmonths
String
“2”
Sample Response Body: { "policyname":"Test 01", "numericrisksettings":[ { "settingsid":"$2", "definition":"10", "descriptiontext":"Frequency - No.of Transactions", "definitiontext":"frequencynooftransaction", "parentnode":"4", "fieldname1":"0", "fieldname2":"10", "operator1":"4", "operator1name":">", "operator2":"2", "operator2name":"<=", "value":"16", "noofmonths":"2" }, { "settingsid":"$3", "definition":"11", "descriptiontext":"Volume - Amount of Transaction", "definitiontext":"volumeamountoftransaction", "parentnode":"5",
"fieldname1":"0", "fieldname2":"15000", "operator1":"4", "operator1name":">", "operator2":"2", "operator2name":"<=", "value":"25", "noofmonths":"4" } ], "variablerisksettings":[ { "settingsid":"$0", "definition":"12", "descriptiontext":"Customer - Nationality Name", "definitiontext":"customernationalityname", "parentnode":"6", "fieldname":"ISRAEL", "operator":"11", "operatorname":"=", "value":"10" }, { "settingsid":"$1", "definition":"12", "descriptiontext":"Customer - Nationality Name", "definitiontext":"customernationalityname", "parentnode":"6", "fieldname":"PAKISTAN", "operator":"12", "operatorname":"!=", "value":"15" }, { "settingsid":"$4", "definition":"40", "descriptiontext":"Customer Category", "definitiontext":"customercategory", "parentnode":"1", "fieldname":"High", "operator":"11", "operatorname":"=", "value":"PEP" } ], "riskscoresettings":[
{ "settingsid":"$5", "definition":"34", "descriptiontext":"Risk Score Setting", "definitiontext":"riskscoresetting", "parentnode":"33", "fieldname":"High", "operator1":"14", "operator1name":">=", "operator2":"13", "operator2name":"<=", "value1":"10", "value2":"50" } ] }
Get Policy ById URL: /risk/getrisksettingsbyid/'+policyId Method: GET Type: JSON Header: Authorization action : read form : riskpolicy
Response Parameters Parameter id policyname company
Type String String String
Description
Sample “0” " TEST " " 0"
IsDefaultInt isdefault
String String
“0”
IsDeletedInt
String
“0”
isdeleted createdbyuserid
String String
“” “0”
""
createdbyusername
String
“”
createddate
String
""
createdtime
String
“”
lasteditedbyuserid
String
“”
lasteditedbyusername
String
“0”
lastediteddate
String
“”
lastediteddate
String
“”
lasteditedtime
String
“”
numericrisksettings
String
id
String
“0”
Settingsid
String
“142”
definition
String
“10”
definitiontext
String
"frequencynooftransaction"
parentnode
String
“4”
operator1
String
“1”
operator1name
String
“<”
fieldname1
String
“0”
operator2
String
“1”
operator2name
String
“<”
fieldname2
String
“0”
value
String
“60”
noofmonths
String
"2"
descriptiontext
String
"Frequency - No.of Transactions"
variablerisksettings
String
id
String
“0”
settingsid definition
String String
"267" "12"
definitiontext
String
"customernationalityname"
parentnode
String
"6"
operator
String
"11"
operatorname
"="
fieldname
String String
value descriptiontext
String String
"10" "0"
riskscoresettings
String
id
String
"Customer - Nationality Name" “0”
settingsid definition
String String
"119" "34"
definitiontext
String
"riskscoresetting"
parentnode
String
“33”
operator1
String
“13”
operator1name
String
"<="
value1
String
“70”
operator2
String
"13"
operator2name
"<="
value2
String String
fieldname
String
"Excellent"
descriptiontext
String
"Risk Score Setting"
"ANDORRA"
"80"
Sample Response Body: { "id":"0", "policyname":"test", "company":"0", "IsDefaultInt":0, "isdefault":"", "IsDeletedInt":0, "isdeleted":"", "createdbyuserid":"0", "createdbyusername":"", "createddate":"", "createdtime":"", "lasteditedbyuserid":"0", "lasteditedbyusername":"", "lastediteddate":"", "lasteditedtime":"", "numericrisksettings":[ { "id":"0", "settingsid":"142", "definition":"10", "definitiontext":"frequencynooftransaction", "parentnode":"4", "operator1":"1", "operator1name":"<", "fieldname1":"0", "operator2":"1", "operator2name":"<", "fieldname2":"0", "value":"60", "noofmonths":"2", "descriptiontext":"Frequency - No.of Transactions" } ], "variablerisksettings":[ { "id":"0", "settingsid":"267", "definition":"12", "definitiontext":"customernationalityname", "parentnode":"6", "operator":"11", "operatorname":"=", "fieldname":"ANDORRA", "value":"10", "noofmonths":"0", "descriptiontext":"Customer - Nationality Name" }, { "id":"0", "settingsid":"268",
"definition":"13", "definitiontext":"customernationalitycurrency", "parentnode":"6", "operator":"11", "operatorname":"=", "fieldname":"UAE DIRHAMS", "value":"20", "noofmonths":"0", "descriptiontext":"Customer - Nationality Currency" }, { "id":"0", "settingsid":"269", "definition":"14", "definitiontext":"customernationalityisfatf", "parentnode":"6", "operator":"11", "operatorname":"=", "fieldname":"False", "value":"30", "noofmonths":"0", "descriptiontext":"Customer - Nationality IsFATF" }, { "id":"0", "settingsid":"270", "definition":"51", "definitiontext":"customernationalityishighrisk", "parentnode":"6", "operator":"11", "operatorname":"=", "fieldname":"False", "value":"40", "noofmonths":"0", "descriptiontext":"Customer - Nationality Is High Risk" }, { "id":"0", "settingsid":"271", "definition":"40", "definitiontext":"customercategory", "parentnode":"1", "operator":"11", "operatorname":"=", "fieldname":"High", "value":"50", "noofmonths":"0", "descriptiontext":"Customer Category" } ], "riskscoresettings":[ { "id":"0", "settingsid":"119", "definition":"34", "definitiontext":"riskscoresetting",
"parentnode":"33", "operator1":"13", "operator1name":"<=", "value1":"70", "operator2":"13", "operator2name":"<=", "value2":"80", "fieldname":"Excellent", "descriptiontext":"Risk Score Setting" } ] }
Update Risk Policy URL: risk/updateriskpolicy Method: GET Type: JSON Header: Authorization action : update form : riskpolicy
Response Parameters Parameter
Sample Response Body: true / false
Type String String
Description
Sample “” ""
Query Login URL: /user/authorize Method: POST Type: JSON Header: Authorization Value: Bearer
Token will get when adding a new user from COMPLY web client.
Request Parameters Parameters username password
Type String String
Mandatory? Description Yes User name of login Yes Password of login
Sample “nabeel” “nabeel”
Response Parameters Parameter customerid status responsecode token
Type String String String String
Description Id of Customer User Status User response Token
Sample “6” “true” “Login Successfull” "eyJhbGciOiJSUzI1Ni IsInR5cCI6IkpXVCJ9. eyJicmFuY2giOiIwIi wiY29tcGFueSI6IjAiL CJleHAiOjE1MjgzMz M2NzMsInVzZXJpZC I6IjYiLCJ1c2VybmFtZ SI6Im5hYmVlbCJ9.B 7OMck1wYG0wOPzt W5yseFZwOVOy3W Zfub_eF96qpfopny2 N4NQwNb7X3N3P9 AMcEfYzIwKhNPsjD RjXfwsxyaHYbKQSYd c9zyKMwxyPI7wh5L 3yelCqCYYyGHto0dXLab28HRfO4vJk wAlNY_jiixk5y6wTwmL
1uu89qYTb8" Sample Request Body: { "username":"nabeel", "password":"nabeel" } Sample Response Body { "customerid":6, "status":"true", "responsecode":"Login Successfull", "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJicmFuY2giOiIwIiwiY29tcGFueSI6IjAiLCJleHAi OjE1MjgzMzM2NzMsInVzZXJpZCI6IjYiLCJ1c2VybmFtZSI6Im5hYmVlbCJ9.B7OMck1wYG0wOPztW 5yseFZwOVOy3WZfub_eF96qpfopny2N4NQwNb7X3N3P9AMcEfYzIwKhNPsjDRjXfwsxyaHYbKQS Ydc9zyKMwxyPI7wh5L3yelCqCYYyGHt-o0dXLab28HRfO4vJkwAlNY_jiixk5y6wTwmL1uu89qYTb8" }
Get All Policies URL: /risk/getallpolicies Method: GET Type: JSON Header: Authorization
Response Parameters Parameter id policyname company
Type String String String
isdefaultint
String
isdefault
String
isdeletedint
String
isdeleted
String
createdbyuserid
String
createdbyusername
String
createddate createdtime lasteditedbyuserid
String String String
lasteditedbyusername String lastediteddate
String
lasteditedtime
String
Description Id of policy Name of policy Company name of policy Check this policy defult (int) Check this policy defult yes or no Check this policy delete (int) Check this policy delete yes or no Id of policy created user Name of policy created user Policy created date Policy created time User id of last edited this policy Name of last edited this policy Date of last policy edited Time of last policy edited
Sample “13” “Al Mana Policy” “0” “0” “Yes” “0” “No” “0” "Admin" “2017-03-02” "05:49 PM" "0" "Admin" “2017-03-02” "05:49 PM"
Sample Response Body [ { "id":"13", "policyname":"Al Mana Policy", "company":"0", "isdefaultint":"1", "isdefault":"Yes", "isdeletedint":0, "isdeleted":"No", "createdbyuserid":"0", "createdbyusername":"Admin", "createddate":"2017-03-02", "createdtime":"05:49 PM", "lasteditedbyuserid":"0", "lasteditedbyusername":"Admin", "lastediteddate":"2018-05-17", "lasteditedtime":"03:58 PM" } ]
Update Default Policy URL: /risk/updatedefaultpolicy Method: POST Type: JSON Header: Authorization
Request Parameters Parameters policyid
Type String
Mandatory? Description Yes Id of policy
Sample “15”
Response Parameters Parameter status
Type String
Sample Request Body: { "policyid":"15" }
Sample Response Body:
true / false
Query Remittance Status URL: /risk/updatepolicystatus Method: POST Type: JSON
Description Status of updated policy True/False
Sample “True”
Header: Authorization
Response Parameters Parameter policyid status
Type String String
Description Id of policy If delete status(to activate) = 0 and if activate status(to delete) = 1
Sample “16” “1”
Description
Sample “:"1” “:"Customer” “:"0” “:"0” “:"0”
Sample Request: } "policyid":"16", "status":"1" } Sample Response Body: true / false
GET RISK DEFINITION URL: risk/getriskdefinition Method: GET Type: JSON Header: Authorization Action : read Form : newpolicy
Response Parameters Parameter id name parentid isendnode hasrelation
Type String String String String String
realtion text hasmonth descriptiontext operatorrelation Sample Response Body: [ { "id":"1", "name":"Customer", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"customer", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" } ]
String String String String String
“:"''” “:"customer” “:"0” “:"''” “:"”
GET RISK DEFINITION - TREE VIEW
URL: /risk/getriskdefinition Method: GET Type: JSON Header: Authorization action : "read" form : "newpolicy"
Response Parameters Parameter id name parentid isendnode hasrelation realtion text hasmonth
Type String String String String String String String String
descriptiontext operatorrelation
String String
Sample Response Body: [ { "id":"1", "name":"Customer", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"customer",
Description
Sample “2” "Product"
" 0" “0” "0" "''" "product" "0" "''" ""
"hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"2", "name":"Product", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"product", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"3", "name":"Jurisdiction", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"jurisdiction", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"4", "name":"Frequency", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"frequency", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"5", "name":"Volume", "parentid":"0", "isendnode":"0", "hasrelation":"0",
"realtion":"''", "text":"volume", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"6", "name":"Nationality", "parentid":"1", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"customernationality", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"7", "name":"IDType", "parentid":"1", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"customeridtype", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"8", "name":"Country", "parentid":"3", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"jurisdictioncountry", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"9", "name":"Service", "parentid":"2",
"isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"productservice", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"10", "name":"No.of Transactions", "parentid":"4", "isendnode":"1", "hasrelation":"0", "realtion":"''", "text":"frequencynooftransaction", "hasmonth":"1", "descriptiontext":"Frequency - No.of Transactions", "operatorrelation":"numeric" }, { "id":"11", "name":"Amount of Transaction", "parentid":"5", "isendnode":"1", "hasrelation":"0", "realtion":"''", "text":"volumeamountoftransaction", "hasmonth":"1", "descriptiontext":"Volume - Amount of Transaction", "operatorrelation":"numeric" }, { "id":"12", "name":"Name", "parentid":"6", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"customernationalityname", "hasmonth":"0", "descriptiontext":"Customer - Nationality Name", "operatorrelation":"variable" }, { "id":"13",
"name":"Currency", "parentid":"6", "isendnode":"1", "hasrelation":"1", "realtion":"currency", "text":"customernationalitycurrency", "hasmonth":"0", "descriptiontext":"Customer - Nationality Currency", "operatorrelation":"variable" }, { "id":"14", "name":"Is FATF", "parentid":"6", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"customernationalityisfatf", "hasmonth":"0", "descriptiontext":"Customer - Nationality IsFATF", "operatorrelation":"variable" }, { "id":"15", "name":"Type", "parentid":"7", "isendnode":"1", "hasrelation":"1", "realtion":"idtype", "text":"customeridtypetype", "hasmonth":"0", "descriptiontext":"Customer - ID Type", "operatorrelation":"variable" }, { "id":"16", "name":"Name", "parentid":"9", "isendnode":"1", "hasrelation":"1", "realtion":"service", "text":"productservicename", "hasmonth":"0", "descriptiontext":"Product - Service Name", "operatorrelation":"variable" },
{ "id":"17", "name":"Is Bank", "parentid":"9", "isendnode":"1", "hasrelation":"1", "realtion":"service", "text":"productserviceisbank", "hasmonth":"0", "descriptiontext":"Product - IsBank", "operatorrelation":"variable" }, { "id":"18", "name":"Is Fast Cash", "parentid":"9", "isendnode":"1", "hasrelation":"1", "realtion":"service", "text":"productserviceisfastcash", "hasmonth":"0", "descriptiontext":"Product - IsFastCash", "operatorrelation":"variable" }, { "id":"19", "name":"Is TT", "parentid":"9", "isendnode":"1", "hasrelation":"1", "realtion":"service", "text":"productserviceistt", "hasmonth":"0", "descriptiontext":"Product - IsTT", "operatorrelation":"variable" }, { "id":"20", "name":"Name", "parentid":"8", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"jurisdictioncountryname", "hasmonth":"0", "descriptiontext":"Jurisdiction - Country Name",
"operatorrelation":"variable" }, { "id":"21", "name":"Currency", "parentid":"8", "isendnode":"1", "hasrelation":"1", "realtion":"currency", "text":"jurisdictioncountrycurrency", "hasmonth":"0", "descriptiontext":"Jurisdiction - Country Currency", "operatorrelation":"variable" }, { "id":"22", "name":"Is FATF", "parentid":"8", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"jurisdictioncountryisfatf", "hasmonth":"0", "descriptiontext":"Jurisdiction - Country IsFATF", "operatorrelation":"variable" }, { "id":"33", "name":"Risk Category", "parentid":"0", "isendnode":"0", "hasrelation":"0", "realtion":"''", "text":"riskcategory", "hasmonth":"0", "descriptiontext":"''", "operatorrelation":"" }, { "id":"34", "name":"Risk Score Settings", "parentid":"33", "isendnode":"1", "hasrelation":"0", "realtion":"''", "text":"riskscoresetting",
"hasmonth":"0", "descriptiontext":"Risk Score Setting", "operatorrelation":"riskscore" }, { "id":"40", "name":"Category", "parentid":"1", "isendnode":"1", "hasrelation":"0", "realtion":"''", "text":"customercategory", "hasmonth":"0", "descriptiontext":"Customer Category", "operatorrelation":"variable" }, { "id":"51", "name":"Is High Risk", "parentid":"6", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"customernationalityishighrisk", "hasmonth":"0", "descriptiontext":"Customer - Nationality Is High Risk", "operatorrelation":"variable" }, { "id":"52", "name":"Is High Risk", "parentid":"8", "isendnode":"1", "hasrelation":"1", "realtion":"country", "text":"jurisdictioncountryishighrisk", "hasmonth":"0", "descriptiontext":"Jurisdiction - Country Is High Risk", "operatorrelation":"variable" } ]
GET NODE OPTIONS BY ID URL: /risk/getnodeoptionsbyid/id -eg:15/34 Method: GET Type: JSON Header: Authorization action : "read" form : "newpolicy"
Response Parameters Parameter QATAR ID PASSPORT COMMERCIAL REGISTRATION VISA COPY DIPLOMATIC ID DRIVING LICENSE
Type String String String
VISITING CUSTOMER
String
OTHER ID RP DC PP CR
String String String String String
String String String
Sample Response Body: [ "QATAR ID", "PASSPORT", "COMMERCIAL REGISTRATION", "VISA COPY", "DIPLOMATIC ID",
Description
Sample “QATAR ID” "PASSPORT" "COMMERCIAL REGISTRATION" “VISA COPY” "DIPLOMATIC ID" "DRIVING LICENSE" "VISITING CUSTOMER” "OTHER ID" "RP" 'DC” "PP" "CR"
"DRIVING LICENSE", "VISITING CUSTOMER", "OTHER ID", "RP", "DC", "PP", "CR" ]
GET NODE OPERATORS URL: /risk/getoperatorsbytype/operatorrelation -eg:variable/riskscore Method: GET Type: JSON Header: Authorization action : "read" form : "newpolicy"
Response Parameters Parameter id name type
Sample Response Body: [ { "id":"11", "name":"=",
Type String String String
Description
Sample “11” ":"=" "variable"
"type":"variable" } ]
Save New Policy URL: risk/saveriskpolicy Method: GET Type: JSON Header: Authorization action : create form : newpolicy
Response Parameters Parameter policyname numericrisksettings definition
Type String String String
Description
Sample “” " $2 " " 10 "
descriptiontext
String
“"Frequency -
definitiontext
String
No.of Transactions"” "frequencynooftransaction"
parentnode
String
“4”
fieldname1 fieldname2
String String
“0” “10”
operator1
String
“4”
operator1name
String
">"
operator2
String
“2”
operator2name
String
“<=”
value
String
“16”
noofmonths
String
“2”
Sample Response Body: { "policyname":"Test 01", "numericrisksettings":[ { "settingsid":"$2", "definition":"10", "descriptiontext":"Frequency - No.of Transactions", "definitiontext":"frequencynooftransaction", "parentnode":"4", "fieldname1":"0", "fieldname2":"10", "operator1":"4", "operator1name":">", "operator2":"2", "operator2name":"<=", "value":"16", "noofmonths":"2" }, { "settingsid":"$3", "definition":"11", "descriptiontext":"Volume - Amount of Transaction", "definitiontext":"volumeamountoftransaction", "parentnode":"5",
"fieldname1":"0", "fieldname2":"15000", "operator1":"4", "operator1name":">", "operator2":"2", "operator2name":"<=", "value":"25", "noofmonths":"4" } ], "variablerisksettings":[ { "settingsid":"$0", "definition":"12", "descriptiontext":"Customer - Nationality Name", "definitiontext":"customernationalityname", "parentnode":"6", "fieldname":"ISRAEL", "operator":"11", "operatorname":"=", "value":"10" }, { "settingsid":"$1", "definition":"12", "descriptiontext":"Customer - Nationality Name", "definitiontext":"customernationalityname", "parentnode":"6", "fieldname":"PAKISTAN", "operator":"12", "operatorname":"!=", "value":"15" }, { "settingsid":"$4", "definition":"40", "descriptiontext":"Customer Category", "definitiontext":"customercategory", "parentnode":"1", "fieldname":"High", "operator":"11", "operatorname":"=", "value":"PEP" } ], "riskscoresettings":[
{ "settingsid":"$5", "definition":"34", "descriptiontext":"Risk Score Setting", "definitiontext":"riskscoresetting", "parentnode":"33", "fieldname":"High", "operator1":"14", "operator1name":">=", "operator2":"13", "operator2name":"<=", "value1":"10", "value2":"50" } ] }
Get Policy ById URL: /risk/getrisksettingsbyid/'+policyId Method: GET Type: JSON Header: Authorization action : read form : riskpolicy
Response Parameters Parameter id policyname company
Type String String String
Description
Sample “0” " TEST " " 0"
IsDefaultInt isdefault
String String
“0”
IsDeletedInt
String
“0”
isdeleted createdbyuserid
String String
“” “0”
""
createdbyusername
String
“”
createddate
String
""
createdtime
String
“”
lasteditedbyuserid
String
“”
lasteditedbyusername
String
“0”
lastediteddate
String
“”
lastediteddate
String
“”
lasteditedtime
String
“”
numericrisksettings
String
id
String
“0”
Settingsid
String
“142”
definition
String
“10”
definitiontext
String
"frequencynooftransaction"
parentnode
String
“4”
operator1
String
“1”
operator1name
String
“<”
fieldname1
String
“0”
operator2
String
“1”
operator2name
String
“<”
fieldname2
String
“0”
value
String
“60”
noofmonths
String
"2"
descriptiontext
String
"Frequency - No.of Transactions"
variablerisksettings
String
id
String
“0”
settingsid definition
String String
"267" "12"
definitiontext
String
"customernationalityname"
parentnode
String
"6"
operator
String
"11"
operatorname
"="
fieldname
String String
value descriptiontext
String String
"10" "0"
riskscoresettings
String
id
String
"Customer - Nationality Name" “0”
settingsid definition
String String
"119" "34"
definitiontext
String
"riskscoresetting"
parentnode
String
“33”
operator1
String
“13”
operator1name
String
"<="
value1
String
“70”
operator2
String
"13"
operator2name
"<="
value2
String String
fieldname
String
"Excellent"
descriptiontext
String
"Risk Score Setting"
"ANDORRA"
"80"
Sample Response Body: { "id":"0", "policyname":"test", "company":"0", "IsDefaultInt":0, "isdefault":"", "IsDeletedInt":0, "isdeleted":"", "createdbyuserid":"0", "createdbyusername":"", "createddate":"", "createdtime":"", "lasteditedbyuserid":"0", "lasteditedbyusername":"", "lastediteddate":"", "lasteditedtime":"", "numericrisksettings":[ { "id":"0", "settingsid":"142", "definition":"10", "definitiontext":"frequencynooftransaction", "parentnode":"4", "operator1":"1", "operator1name":"<", "fieldname1":"0", "operator2":"1", "operator2name":"<", "fieldname2":"0", "value":"60", "noofmonths":"2", "descriptiontext":"Frequency - No.of Transactions" } ], "variablerisksettings":[ { "id":"0", "settingsid":"267", "definition":"12", "definitiontext":"customernationalityname", "parentnode":"6", "operator":"11", "operatorname":"=", "fieldname":"ANDORRA", "value":"10", "noofmonths":"0", "descriptiontext":"Customer - Nationality Name" }, { "id":"0", "settingsid":"268",
"definition":"13", "definitiontext":"customernationalitycurrency", "parentnode":"6", "operator":"11", "operatorname":"=", "fieldname":"UAE DIRHAMS", "value":"20", "noofmonths":"0", "descriptiontext":"Customer - Nationality Currency" }, { "id":"0", "settingsid":"269", "definition":"14", "definitiontext":"customernationalityisfatf", "parentnode":"6", "operator":"11", "operatorname":"=", "fieldname":"False", "value":"30", "noofmonths":"0", "descriptiontext":"Customer - Nationality IsFATF" }, { "id":"0", "settingsid":"270", "definition":"51", "definitiontext":"customernationalityishighrisk", "parentnode":"6", "operator":"11", "operatorname":"=", "fieldname":"False", "value":"40", "noofmonths":"0", "descriptiontext":"Customer - Nationality Is High Risk" }, { "id":"0", "settingsid":"271", "definition":"40", "definitiontext":"customercategory", "parentnode":"1", "operator":"11", "operatorname":"=", "fieldname":"High", "value":"50", "noofmonths":"0", "descriptiontext":"Customer Category" } ], "riskscoresettings":[ { "id":"0", "settingsid":"119", "definition":"34", "definitiontext":"riskscoresetting",
"parentnode":"33", "operator1":"13", "operator1name":"<=", "value1":"70", "operator2":"13", "operator2name":"<=", "value2":"80", "fieldname":"Excellent", "descriptiontext":"Risk Score Setting" } ] }
Update Risk Policy URL: risk/updateriskpolicy Method: GET Type: JSON Header: Authorization action : update form : riskpolicy
Response Parameters Parameter
Sample Response Body: true / false
Type String String
Description
Sample “” ""
More Documents from "Maruff Mohd"
Comply_technical_integration_document.docx
December 2019 0
7507.pdf
April 2020 1
Bdg_eroeffnungssysteme_en.pdf
October 2019 1
Appreciation Certificate Format.docx
May 2020 31