COMPLY Technical Integration Document

TECHNICAL INTEGRATION DOCUMENT
Query Login
URL: /user/authorize
Method: POST
Type: JSON
Header: Authorization
Value: Bearer <Token>
• Token will get when adding a new user from COMPLY web client.
Request Parameters
Parameters Type Mandatory? Description Sample
username String Yes User name of login “nabeel”
password String Yes Password of login “nabeel”
Response Parameters
Parameter Type Description Sample
customerid String Id of Customer “6”
status String User Status “true”
responsecode String User response “Login Successfull”
token String Token "eyJhbGciOiJSUzI1Ni
IsInR5cCI6IkpXVCJ9.
eyJicmFuY2giOiIwIi
wiY29tcGFueSI6IjAiL
CJleHAiOjE1MjgzMz
M2NzMsInVzZXJpZC
I6IjYiLCJ1c2VybmFtZ
SI6Im5hYmVlbCJ9.B
7OMck1wYG0wOPzt
W5yseFZwOVOy3W
Zfub_eF96qpfopny2
N4NQwNb7X3N3P9
AMcEfYzIwKhNPsjD
RjXfwsxyaHYbKQSYd
c9zyKMwxyPI7wh5L
3yelCqCYYyGHt-
o0dXLab28HRfO4vJk
wA-
lNY_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-o0dXLab28HRfO4vJkwA-
lNY_jiixk5y6wTwmL1uu89qYTb8"
}
Get All Policies
URL: /risk/getallpolicies
Method: GET
Type: JSON
Response Parameters
id String Id of policy “13”
policyname String Name of policy “Al Mana Policy”
company String Company name of “0”
policy
isdefaultint String Check this policy defult “0”
(int)
isdefault String Check this policy defult “Yes”
yes or no
isdeletedint String Check this policy delete “0”
(int)
isdeleted String Check this policy delete “No”
yes or no
createdbyuserid String Id of policy created “0”
user
createdbyusername String Name of policy created "Admin"
user
createddate String Policy created date “2017-03-02”
createdtime String Policy created time "05:49 PM"
lasteditedbyuserid String User id of last edited "0"
this policy
lasteditedbyusername String Name of last edited this "Admin"
policy
lastediteddate String Date of last policy “2017-03-02”
edited
lasteditedtime String Time of last policy "05:49 PM"
edited
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
Request Parameters
Parameters Type Mandatory? Description Sample
policyid String Yes Id of policy “15”
Response Parameters
status String Status of updated policy True/False “True”
Sample Request Body:

{
"policyid":"15"
}
Sample Response Body:
true / false
Query Remittance Status

URL: /risk/updatepolicystatus
Method: POST
Type: JSON
Response Parameters
policyid String Id of policy “16”
status String If delete status(to activate) = 0 and if “1”
activate status(to delete) = 1
Sample Request:
}
"policyid":"16",
"status":"1"
}
true / false
GET RISK DEFINITION

URL: risk/getriskdefinition
Method: GET
Type: JSON
Action : read
Form : newpolicy
Response Parameters
id String “:"1”
name String “:"Customer”
parentid String “:"0”
isendnode String “:"0”
hasrelation String “:"0”
realtion String “:"''”
text String “:"customer”
hasmonth String “:"0”
descriptiontext String “:"''”
operatorrelation String “:"”

[
{
"id":"1",
"name":"Customer",
"parentid":"0",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"customer",
"hasmonth":"0",
"descriptiontext":"''",
"operatorrelation":""
}
]
GET RISK DEFINITION - TREE VIEW
URL: /risk/getriskdefinition
Method: GET
Type: JSON
action : "read"
form : "newpolicy"
Response Parameters
id String “2”
name String "Product"
parentid String " 0"
isendnode String “0”
hasrelation String "0"
realtion String "''"
text String "product"
hasmonth String "0"
descriptiontext String "''"

operatorrelation String ""

[
{
"id":"1",
"name":"Customer",
"parentid":"0",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"customer",
"hasmonth":"0",
},
{
"id":"2",
"name":"Product",
"parentid":"0",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"product",
"hasmonth":"0",
},
{
"id":"3",
"name":"Jurisdiction",
"parentid":"0",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"jurisdiction",
"hasmonth":"0",
},
{
"id":"4",
"name":"Frequency",
"parentid":"0",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"frequency",
"hasmonth":"0",
},
{
"id":"5",
"name":"Volume",
"parentid":"0",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"volume",
"hasmonth":"0",
},
{
"id":"6",
"name":"Nationality",
"parentid":"1",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"customernationality",
"hasmonth":"0",
},
{
"id":"7",
"name":"IDType",
"parentid":"1",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"customeridtype",
"hasmonth":"0",
},
{
"id":"8",
"name":"Country",
"parentid":"3",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"jurisdictioncountry",
"hasmonth":"0",
},
{
"id":"9",
"name":"Service",
"parentid":"2",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"productservice",
"hasmonth":"0",
},
{
"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",
},
{
"id":"14",
"name":"Is FATF",
"parentid":"6",
"isendnode":"1",
"hasrelation":"1",
"text":"customernationalityisfatf",
"hasmonth":"0",
"descriptiontext":"Customer - Nationality IsFATF",
},
{
"id":"15",
"name":"Type",
"parentid":"7",
"isendnode":"1",
"hasrelation":"1",
"realtion":"idtype",
"text":"customeridtypetype",
"hasmonth":"0",
"descriptiontext":"Customer - ID Type",
},
{
"id":"16",
"name":"Name",
"parentid":"9",
"isendnode":"1",
"hasrelation":"1",
"realtion":"service",
"text":"productservicename",
"hasmonth":"0",
"descriptiontext":"Product - Service Name",
},
{
"id":"17",
"name":"Is Bank",
"parentid":"9",
"isendnode":"1",
"hasrelation":"1",
"text":"productserviceisbank",
"hasmonth":"0",
"descriptiontext":"Product - IsBank",
},
{
"id":"18",
"name":"Is Fast Cash",
"parentid":"9",
"isendnode":"1",
"hasrelation":"1",
"text":"productserviceisfastcash",
"hasmonth":"0",
"descriptiontext":"Product - IsFastCash",
},
{
"id":"19",
"name":"Is TT",
"parentid":"9",
"isendnode":"1",
"hasrelation":"1",
"text":"productserviceistt",
"hasmonth":"0",
"descriptiontext":"Product - IsTT",
},
{
"id":"20",
"name":"Name",
"parentid":"8",
"isendnode":"1",
"hasrelation":"1",
"text":"jurisdictioncountryname",
"hasmonth":"0",
"descriptiontext":"Jurisdiction - Country Name",
},
{
"id":"21",
"name":"Currency",
"parentid":"8",
"isendnode":"1",
"hasrelation":"1",
"realtion":"currency",
"text":"jurisdictioncountrycurrency",
"hasmonth":"0",
"descriptiontext":"Jurisdiction - Country Currency",
},
{
"id":"22",
"name":"Is FATF",
"parentid":"8",
"isendnode":"1",
"hasrelation":"1",
"text":"jurisdictioncountryisfatf",
"hasmonth":"0",
"descriptiontext":"Jurisdiction - Country IsFATF",
},
{
"id":"33",
"name":"Risk Category",
"parentid":"0",
"isendnode":"0",
"hasrelation":"0",
"realtion":"''",
"text":"riskcategory",
"hasmonth":"0",
},
{
"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",
},
{
"id":"51",
"name":"Is High Risk",
"parentid":"6",
"isendnode":"1",
"hasrelation":"1",
"text":"customernationalityishighrisk",
"hasmonth":"0",
"descriptiontext":"Customer - Nationality Is High Risk",
},
{
"id":"52",
"name":"Is High Risk",
"parentid":"8",
"isendnode":"1",
"hasrelation":"1",
"text":"jurisdictioncountryishighrisk",
"hasmonth":"0",
"descriptiontext":"Jurisdiction - Country Is High Risk",
}
]
GET NODE OPTIONS BY ID
URL: /risk/getnodeoptionsbyid/id -eg:15/34
Method: GET
Type: JSON
action : "read"
form : "newpolicy"
Response Parameters
QATAR ID String “QATAR ID”
PASSPORT String "PASSPORT"
COMMERCIAL String "COMMERCIAL
REGISTRATION REGISTRATION"
VISA COPY String “VISA COPY”
DIPLOMATIC ID String "DIPLOMATIC ID"
DRIVING LICENSE String "DRIVING
LICENSE"
VISITING CUSTOMER String "VISITING
CUSTOMER”
OTHER ID String "OTHER ID"
RP String "RP"
DC String 'DC”
PP String "PP"
CR String "CR"

[
"QATAR ID",
"PASSPORT",
"COMMERCIAL REGISTRATION",
"VISA COPY",
"DIPLOMATIC ID",
"DRIVING LICENSE",
"VISITING CUSTOMER",
"OTHER ID",
"RP",
"DC",
"PP",
"CR"
]
GET NODE OPERATORS

URL: /risk/getoperatorsbytype/operatorrelation -eg:variable/riskscore
Method: GET
Type: JSON
action : "read"
form : "newpolicy"
Response Parameters
id String “11”
name String ":"="
type String "variable"

[
{
"id":"11",
"name":"=",
"type":"variable"
}
]
Save New Policy

URL: risk/saveriskpolicy
Method: GET
Type: JSON
action : create
form : newpolicy
Response Parameters
policyname String “”
numericrisksettings String " $2 "
definition String " 10 "
descriptiontext String “"Frequency -
No.of Transactions"”
definitiontext String "frequencynooftransaction"
parentnode String “4”
fieldname1 String “0”
operator1 String “4”
operator1name String ">"
operator2name String “<=”
value String “16”
noofmonths String “2”

{
"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",
"value":"25",
"noofmonths":"4"
}
],
"variablerisksettings":[
{
"settingsid":"$0",
"definition":"12",
"definitiontext":"customernationalityname",
"parentnode":"6",
"fieldname":"ISRAEL",
"operator":"11",
"operatorname":"=",
"value":"10"
},
{
"settingsid":"$1",
"definition":"12",
"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",
"value1":"10",
"value2":"50"
}
]
}
Get Policy ById

URL: /risk/getrisksettingsbyid/'+policyId
Method: GET
Type: JSON
action : read
form : riskpolicy
Response Parameters
id String “0”
policyname String " TEST "
company String " 0"
IsDefaultInt String “0”
isdefault String ""
IsDeletedInt String “0”
isdeleted String “”
createdbyuserid 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"

operator1name String “<”
operator2name String “<”
value String “60”
noofmonths String "2"
descriptiontext String "Frequency - No.of

Transactions"
variablerisksettings String
id String “0”
settingsid String "267"
definition String "12"
definitiontext String "customernationalityname"
parentnode String "6"

operator String "11"
operatorname String "="
fieldname String "ANDORRA"
value String "10"
descriptiontext String "0"
riskscoresettings String "Customer - Nationality
Name"
id String “0”
settingsid String "119"

definition String "34"
definitiontext String "riskscoresetting"


operator1name String "<="
value1 String “70”
operator2 String "13"
operator2name String "<="

value2 String "80"
fieldname String "Excellent"
descriptiontext String "Risk Score Setting"

{
"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",
"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",
"value1":"70",
"operator2":"13",
"value2":"80",
"fieldname":"Excellent",
"descriptiontext":"Risk Score Setting"
}
]
}
Update Risk Policy
URL: risk/updateriskpolicy
Method: GET
Type: JSON
action : update
form : riskpolicy
Response Parameters
String “”
String ""

true / false

COMPLY Technical Integration Document

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

COMPLY Technical Integration Document

Transféré par

Droits d'auteur :

Formats disponibles

TECHNICAL INTEGRATION DOCUMENT

Sample Request Body:

Sample Request Body:

Sample Response Body:

Query Remittance Status

GET RISK DEFINITION

Sample Response Body:

descriptiontext String "''"

Sample Response Body:

Sample Response Body:

GET NODE OPERATORS

Sample Response Body:

Save New Policy

Sample Response Body:

Get Policy ById

Settingsid String “142”

definition String “10”

definitiontext String "frequencynooftransaction"

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

definitiontext String "customernationalityname"

parentnode String "6"

settingsid String "119"

definitiontext String "riskscoresetting"

operator1 String “13”

value1 String “70”

operator2 String "13"

operator2name String "<="

fieldname String "Excellent"

descriptiontext String "Risk Score Setting"

Update Risk Policy

Sample Response Body:

Vous aimerez peut-être aussi