Local List Methods | Sanction Scanner Developer Portal

Get Local List Categories

Required input informations of GetLocalListCategories Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/LocalList/GetLocalListCategories

This service allows listing all of your Local List Categories in your organization. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
CategoryKey	String	Key of Category
CategoryName	String	Name of Category

https://api.sanctionscanner.com/api/LocalList/GetLocalListCategories

The result of the call is a result and the status of the transaction is returned in response. In successful transactions , this status returns to 200, and in unsuccessful transactions it returns to 400.

Sample Service Response Codes

 

//Request 
GET /api/LocalList/GetLocalListCategories 

//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": [
        {
            "CategoryKey": "*****-*****-*****",
            "CategoryName": "*******"
        },
        {
            "CategoryKey": "*****-*****-*****",
            "CategoryName": "*******"
        }
    ]
}

New Local List

Required input informations of NewBlackList Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
https://api.sanctionscanner.com/api/LocalList/NewBlackList

This method is used to add a new record local list.The “POST” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This method allows you to create your own local blacklist outside the global existing records in the system. The records that you add using this service,searches will also be displayed in your results if they meet the match conditions.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
TypeId	Integer	Yes	One of the following values must be sent; 1:Individual 2:Corporate 3:Vessel 4:Aircraft
FirstName	String	Yes	Name Of Record (Individual, Corporate, Vessel, Aircraft)
SecondName	String	No	Second Name Of Record (Only in Individual)
LastName	String	Yes	Last Name Of Record (Only in Individual)
BirthDayDate	DateTime	Yes	BirthDay Date Of Record (Only in Individual)
NationalityId	String	Yes	The Selected Id From The List Should Be Written Here.
DocumentNumber	Integer	Yes	Document Number Of Record
OtherInformation	String	No	Other Information
ExtraInfo	String	No	Extra Information
ReferenceNumber	String	No	Reference Number Of Record
Akaname	String	No	Nickname or Original Script of Record
PhoneNumber	String	No	Phone Number

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
PhoneNumber	String	Phone Number
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
FirstName	String	Name Of Queried Record
SecondName	String	Second Name Of Queried Record
LastName	String	Surname Name Of Queried Record
ListedOn	DateTime	Date Of Entry To List
BirthDayDate	DateTime	Birthday Of Queried Record
DocumentNumber	Integer	Document Number Of Record
OtherInformation	String	Other Information About Queried Record
ExtraInfo	String	Extra Information Of Queried Record
FullName	String	Full Name Of Queried Record
Guid	String	Guid Of Queried Record
ReferenceNumber	String	Reference Number Of Record
Akaname	String	Nickname or Original Script of Record
PhoneNumber	String	Phone Number

https://api.sanctionscanner.com/api/LocalList/NewBlackList

In the link above, a call must be made using NewBlackList.

Sample Service Response Codes

 

//Request 
      {
        "TypeId": 1,
        "FirstName": "*****",
        "SecondName":"*****",
        "LastName":"*****",
        "BirthDayDate": "DateTime",
        "NationalityId":1,
        "DocumentNumber": "*****",
        "ExtraInfo":"",
        
        "ReferenceNumber":"*****",
        "AkaName":"*****"
      }


//Response
{
       "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "FirstName": "*****",
        "SecondName": "****",
        "LastName": "*******",
        "ListedOn": "dd.mm.yyyy",
        "NationalityId": 1,
        "Nationality": "Turkish",
        "BirthDayDate": "1995-12-10",
        "DocumentType": null,
        "DocumentNumber": "********",
        "ExtraInfo": "",
        "FullName": "***********",
        "OrganizationId": 1,
        "Guid": "****-1271-**-b419-0b22e24a7e79",
        "Id": 0,
        "IsDeleted": false,
        "CreatedDate": "2019-05-13",
        "ModifiedDate": null,
        "CreatedUserId": 1,
        "ModifiedUserId": null,
        "IpAddress": null,
        
        "ReferenceNumber":"*****",
        "AkaName":"*****"
    }

}

Get Local List By Id

Required input informations of GetBlackListById Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/LocalList/GetBlackListById?guid=Guid

This method is used to getting record details from the local black list. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This method allows you to see the details of the local list record you have added. To use this method, you must send the given "Guid" value when you add the original record.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
Guid	String	Yes	Guid Of Record To Query

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
FirstName	String	Name Of Queried Record
SecondName	String	Second Name Of Queried Record
LastName	String	Surname Name Of Queried Record
ListedOn	DateTime	Date Of Entry To List
BirthDayDate	DateTime	Birthday Of Queried Record
DocumentNumber	Integer	Document Number Of Record
OtherInformation	String	Other Information About Queried Record
ExtraInfo	String	Extra Information Of Queried Record
FullName	String	Full Name Of Queried Record
Guid	String	Guid Of Queried Record
ReferenceNumber	String	Reference Number Of Record
Akaname	String	Nickname or Original Script of Record
PhoneNumber	String	Phone Number

https://api.sanctionscanner.com/api/LocalList/GetBlackListById?guid=Guid

In the link above, a call must be made using the guid of the Record to be queried instead of the field that is in the “Guid” field.

Sample Service Response Codes

 

//Request 
GET /api/LocalBlackList/GetBlackListById?guid=

//Response
{   
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "FirstName": "*****",
        "SecondName": "*****",
        "LastName": "*****",
        "ListedOn": "2019-05-01T14:33:02.483",
        "Nationality": "1",
        "BirthDayDate": "1996-12-10T00:00:00",
        "DocumentType": null,
        "DocumentNumber": "*****",
        "ExtraInfo": "",
        "FullName": "*****",
        "OrganizationId": 1,
        "Guid": "*****",
        "Id": *****,
        "IsDeleted": false,
        "CreatedDate": "2019-05-01T14:32:48.5",
        "ModifiedDate": null,
        "CreatedUserId": *****,
        "ModifiedUserId": null,
        "IpAddress": null,
        
        "ReferenceNumber":"*****",
        "AkaName":"******"

}

Local List Update

Required input informations of UpdateBlackList Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
https://api.sanctionscanner.com/api/LocalList/UpdateBlackList

This method is used to update details that previously added local list. The “POST” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This method allows you to edit the record that you have previously added to the system.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
TypeId	Integer	Yes	One of the following values must be sent; 1:Individual 2:Corporate 3:Vessel 4:Aircraft
FirstName	String	Yes	Name Of Record (Individual, Corporate, Vessel, Aircraft)
SecondName	String	No	Second Name Of Record (Only in Individual)
LastName	String	Yes	Last Name Of Record (Only in Individual)
BirthDayDate	String	Yes	BirthDay Of Record
NationalityId	String	Yes	The Selected Id From The List Should Be Written Here.
DocumentNumber	String	Yes	Document Number Of Record
OtherInformation	String	No	Other Information
ExtraInfo	String	No	Extra Information
Guid	String	Yes	Guid
ReferenceNumber	String	No	Reference Number Of Record
Akaname	String	No	Nickname or Original Script of Record
PhoneNumber	String	No	Phone Number

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information.

Result Class Informations

Parameter Name	Data Type	Description
FirstName	String	Name Of Queried Record
SecondName	String	Second Name Of Queried Record
LastName	String	Surname Name Of Queried Record
ListedOn	DateTime	Date Of Entry To List
BirthDayDate	DateTime	Birthday Of Queried Record
DocumentNumber	Integer	Document Number Of Record
OtherInformation	String	Other Information About Queried Record
ExtraInfo	String	Extra Information Of Queried Record
FullName	String	Full Name Of Queried Record
Guid	String	Guid Of Queried Record
ReferenceNumber	String	Reference Number Of Record
Akaname	String	Nickname or Original Script of Record
PhoneNumber	String	Phone Number

https://api.sanctionscanner.com/api/LocalList/UpdateBlackList

In the link above, a call is updated guid using the UpdateBlackList.

Sample Service Response Codes

 

//Request 
 {
        "FirstName": "*****",
        "SecondName":"*****",
        "LastName":"*****",
        "BirthDayDate": "DateTime",
        "DocumentNumber": "*****",
        "NationalityId": 1,
        "ExtraInfo":"",
	    "Guid":"*****",
        
        "ReferenceNumber":"*****",
        "AkaName":"*****"
      }


//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "FirstName": "*****",
        "SecondName": "****",
        "LastName": "*******",
        "ListedOn": "dd.mm.yyyy",
        "NationalityId": 1,
        "Nationality": "Turkish",
        "BirthDayDate": "1995-12-10",
        "DocumentType": null,
        "DocumentNumber": "********",
        "OtherInformation": "",
        "ExtraInfo": "",
        "FullName": "***********",
        "OrganizationId": 1,
        "Guid": "****-1271-**-b419-0b22e24a7e79",
        "Id": 0,
        "IsDeleted": false,
        "CreatedDate": "2019-05-13",
        "ModifiedDate": null,
        "CreatedUserId": 1,
        "ModifiedUserId": null,
        "IpAddress": null,
        
        "ReferenceNumber":"*****",
        "AkaName":"*****"
    }
}

Local List Delete

Required input informations of DeleteBlackList Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
https://api.sanctionscanner.com/api/LocalList/DeleteBlackList

This method is used to delete the added local list. The “POST” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This methods allows you to delete the record that you have previously added to the system.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
Guid	String	Yes	Guid Of Record

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information.

https://api.sanctionscanner.com/api/LocalList/DeleteBlackList

In the link above, a call is deleted guid using the DeleteBlackList.

Sample Service Response Codes

 

//Request 
    {
		"Guid":"*****"
    }


//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": null
}

Nationality Informations

Id	Country	Nationality
1	Turkey	Turkish
2	Afghanistan	Afghani
3	Aland Islands	Aland Islands
4	Germany	German
5	United States of America	American
6	US Minor Outlying Islands	US Minor Outlying Islands
7	American Samoa	Austrian
8	Andorra	Andorian
9	Angola	Angolian
10	Anguilla	Anguillan
11	Antarctica	Antarctic
12	Antigua and Barbuda	Antiguan, Barbudan
13	Argentina	Argentine
14	Albania	Albanian
15	Aruba	Arubian
16	Australia	Australian
17	Austria	Austrian
18	Azerbaijan	Azerbaijani
19	Bahamas	Bahameese
20	Bahrain	Bahrainian
21	Bangladesh	Bangladeshi
22	Barbados	Barbadian
23	Western Sahara	Western Saharan
24	Belarus	Belarusian
25	Belgium	Belgian
26	Belize	Belizean
27	Benin	Beninese
28	Bermuda	Bermuda
29	Guernsey	Guernsey
30	United Arab Emirates	Emirian
31	United Kingdom	British
32	Bolivia	Bolivian
33	Bosnia and Herzegovina	Bangladeshi
34	Botswana	Motswana
35	Bouvet Island	Bouvet Island
36	Brazil	Brazilian
37	Brunei Darussalam	Bruneian
38	Bulgaria	Bulgarian
39	Burkina Faso	Burkinabe
40	Burundi	Burundian
41	Bhutan	Bhutanese
42	Cape Verde	Cape Verdean
43	Cayman Islands	Caymanian
44	Gibraltar	Gibralterian
45	Algeria	Algerian
46	Djibouti	Djiboutian
47	Côte d''Ivoire	Ivorian
48	Cocos (Keeling) Islands	Cocossian
49	Cook Islands	Cook Islander
50	Chad	Chadian
51	Czech Republic	Czech
52	China	Chinese
53	Denmark	Danish
54	Palestinian Territory	Palestinian
55	Dominican Republic	Dominican
56	Dominica	Dominican
57	Ecuador	Ecuadorean
58	Equatorial Guinea	Equatorial Guinean
59	El Salvador	Salvadorean
60	Indonesia	Indonesian
61	Eritrea	Eritrean
62	Armenia	Armenian
63	Estonia	Estonian
64	Ethiopia	Ethiopian
65	Falkland Islands (Malvinas)	Falkland Islander
66	Faroe Islands	Faroese
67	Morocco	Moroccan
68	Fiji	Fijian
69	Philippines	Filipino
70	Finland	Finnish
71	France	French
72	French Guiana	French Guianese
73	French Southern Territories	French Southern Territories
74	French Polynesia	French Polynesian
75	Gabon	Gabonese
76	Gambia	Gambian
77	Ghana	Ghanaian
78	Guinea	Guinean
79	Guinea-Bissau	Guinean
80	Togo	Togolese
81	Grenada	Grenadian
82	Greenland	Greenlander
83	Guadeloupe	Guadeloupean
84	Guam	Guamanian
85	Guatemala	Guatemalan
86	Guyana	Guyanese
87	South Africa	South African
88	South Georgia and the South Sandwich Islands	South Georgia and the South Sandwich Islands
89	South Sudan	Sudanese
90	Georgia	Georgian
91	Haiti	Haitian
92	Heard and Mcdonald Islands	Heard and Mcdonald Islands
93	Croatia	Croatian
94	India	Indian
95	Netherlands	Dutch
96	Holy See (Vatican City State)	Holy See (Vatican City State)
97	Honduras	Honduran
98	Hong Kong, SAR China	Chinese
99	Iraq	Iraqi
100	Isle of Man	Manx
101	British Indian Ocean Territory	British Indian Ocean Territory
102	British Virgin Islands	Virgin Islander
103	Iran, Islamic Republic of	Iranian
104	Ireland	Irish
105	Spain	Spanish
106	Israel	Israeli
107	Grenada	Grenadian
108	Switzerland	Swiss
109	Italy	Italian
110	Iceland	Israeli
111	Jamaica	Jamaican
112	Japan	Japanese
113	Jersey	Jersey
114	Cambodia	Cambodian
115	Cameroon	Cambodian
116	Canada	Canadian
117	Montenegro	Mexican
118	Qatar	Qatari
119	Kazakhstan	Kazakhstani
120	Kenya	Kenyan
121	Cyprus	Cypriot
122	Kyrgyzstan	Kyrgyzstani
123	Kiribati	I-Kiribati
124	Colombia	Columbian
125	Comoros	Comoran
126	Congo (Brazzaville)	Congolese
127	Congo, (Kinshasa)	Congolese
128	Korea (South)	South Korean
129	Korea (North)	North Korean
130	Costa Rica	Czech
131	Kuwait	Kuwaiti
132	Northern Mariana Islands	Northern Mariana Islander
133	Cuba	Cuban
134	Lao PDR	Laotian
135	Lesotho	Mosotho
136	Latvia	Latvian
137	Liberia	Liberian
138	Libya	Libyan
139	Liechtenstein	Liechtensteiner
140	Lithuania	Lithunian
141	Lebanon	Lebanese
142	Luxembourg	Luxembourger
143	Macao, SAR China	Macau
144	Hungary	Hungarian
145	Madagascar	Malagasy
146	Macedonia, Republic of	Macedonian
147	Malawi	Malawian
148	Maldives	Maldivan
149	Malaysia	Malaysian
150	Mali	Malian
151	Malta	Maltese
152	Marshall Islands	Marshallese
153	Martinique	Martinican
154	Mauritius	Mauritian
155	Mayotte	Mahoran
156	Mexico	Mexican
157	Egypt	Egyptian
158	Micronesia, Federated States of	Micronesian
159	Mongolia	Mongolian
160	Moldova	Moldovan
161	Monaco	Monacan
162	Montserrat	Montserratian
163	Mauritania	Mauritanian
164	Mozambique	Mozambican
165	Myanmar	Mayanmarese
166	Namibia	Namibian
167	Nauru	Nauruan
168	Nepal	Nepalese
169	Niger	Nigerien
170	Nigeria	Nigerian
171	Nicaragua	Nicaraguan
172	Niue	Niuean
173	Christmas Island	Christmas Islander
174	Norfolk Island	Norfolk Islander
175	Norway	Norwegian
176	Central African Republic	Central African
177	Uzbekistan	Uzbekistani
178	Pakistan	Pakistani
179	Palau	Palauan
180	Panama	Panamanian
181	Papua New Guinea	Papua New Guinean
182	Paraguay	Paraguayan
183	Peru	Peruvian
184	Pitcairn	Pitcairn Islander
185	Poland	Polish
186	Portugal	Portugees
187	Puerto Rico	Puerto Rican
188	Réunion	Réunion
189	Romania	Romanian
190	Rwanda	Rwandan
191	Russian Federation	Russian
192	Saint-Barthélemy	BarthÈlemoisSaint
193	Saint Helena	Saint Helenian
194	Saint Kitts and Nevis	Kittian
195	Saint Lucia	Saint Lucian
196	Saint-Martin (French part)	Saint-Martin (French part)
197	Saint Pierre and Miquelon	Saint-Pierrais
198	Saint Vincent and Grenadines	Saint Vincentian
199	Samoa	Samoan
200	San Marino	Sanmarinese
201	Sao Tome and Principe	Sao Tomean
202	Senegal	Senegalese
203	Seychelles	Seychellois
204	Serbian	Serbian
205	Sierra Leone	Sierra Leonean
206	Singapore	Singaporean
207	Slovakia	Slovakian
208	Slovenia	Slovenian
209	Solomon Islands	Solomon Islander
210	Somalia	Somali
211	Sri Lanka	Sri Lankan
212	Sudan	Sudanese
213	Suriname	Surinamer
214	Syrian Arab Republic (Syria)	Syrian
215	Saudi Arabia	Saudi Arabian
216	Svalbard and Jan Mayen Islands	Svalbard and Jan Mayen Islands
217	Swaziland	Swazi
218	Chile	Chilean
219	Tajikistan	Tajikistani
220	Tanzania, United Republic of	Tanzanian
221	Thailand	Thai
222	Taiwan, Republic of China	Taiwanese
223	Timor-Leste	Timorese
224	Tokelau	Tokelauan
225	Tonga	Tongan
226	Trinidad and Tobago	Trinidadian
227	Tunisia	Tunisian
228	Turks and Caicos Islands	Turks and Caicos Islander
229	Tuvalu	Tuvaluan
231	Turkmenistan	Turkmen
232	Uganda	Ugandan
233	Ukraine	Ukrainian
234	Oman	Omani
235	Uruguay	Uruguayan
236	Jordan	Jordanian
237	Vanuatu	Ni-Vanuatu
238	Venezuela (Bolivarian Republic)	Venezuelan
239	Viet Nam	Vietnamese
240	Wallis and Futuna Islands	Wallisian
241	Yemen	Yemeni
242	New Caledonia	New Caledonian
243	New Zealand	New Zealander
244	Greece	Greek
245	Zambia	Zambian
246	Zimbabwe	Zimbabwean
247	Virgin Islands, US	U.S Virgin Island

New White List

Required input informations of NewWhiteList Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
https://api.sanctionscanner.com/api/GeneralWhiteList/NewWhiteList

This service is used to add a new white list.The “POST” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This service allows you to add whitelist, Individual, entity/organization, vessel or aircraft information or document numbers that you do not want to give results in your searches. If you match the records you have added to the white list in your searches, the alarm will not be generated and the result will not be displayed.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
TypeId	Integer	Yes	One of the following values must be sent; 1:Individual 2:Corporate 3:Vessel 4:Aircraft
Name	String	Yes	Name Of (Individual, Corporate, Vessel, Aircraft)
IdentityNumber	String	No	Identity Number Of the Record (Only in Individual)
PassportNumber	String	No	Passport Number Of the Record (Only in Individual)
ReferenceNumber	String	No	Reference Number
Description	String	No	Description

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
Name	String	Name Of the Record (Only in Individual)
IdentityNumber	String	Identity Number Of the Record (Only in Individual)
PassportNumber	String	Passport Number Of the Record (Only in Individual)
HashedIdentityNumber	String	Hashed Identity Number Of the Record (Only in Individual)
HashedPassportNumber	String	Hashed Passport Number Of the Record (Only in Individual)
Source	String	Created Source (Web Or Api)
OrganizationName	String	Organization Name
ReferenceNumber	String	Reference Number Of Record
Description	String	Description Of Record
Guid	String	Guid Of the Record (Only in Individual)
CreatedDate	DateTime	Created Date
CreatedUserName	String	Created User Name
ModifiedDate	DateTime	Modified Date
ModifiedUserName	String	Modified User Name

https://api.sanctionscanner.com/api/GeneralWhiteList/NewWhiteList

In the link above, a call must be made using NewWhiteList.

Sample Service Response Codes

 

//Request 
      {
        "TypeId": 1,
        "Name": "",
        "IdentityNumber":"",
        "PassportNumber":"",
        "ReferenceNumber": "",
        "Description": "",
      }


//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "Name": "",
        "IdentityNumber": "",
        "PassportNumber": "",
        "HashedIdentityNumber": "",
        "HashedPassportNumber": "",
        "Source": "",
        "OrganizationName": "",
        "ReferenceNumber": "",
        "Description": "",
        "Guid": "",
        "CreatedDate": "",
        "CreatedUserName": "",
        "ModifiedDate": "",
        "ModifiedUserName": ""
    }
}

Get White List By Id

Required input informations of GetWhiteListById Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/GeneralWhiteList/GetWhiteListById?guid=Guid

This method is used to getting details if the guid of the record is on the white list. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This method allows you to see the details of the white list that you have previously added. To use this method, you must send the given "Guid" value when you add the original record.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
Guid	String	Yes	Guid Of the Record

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
Name	String	Name Of Record
IdentityNumber	String	Identity Number Of the Record (Only in Individual)
PassportNumber	String	Passport Number Of the Record (Only in Individual)
HashedIdentityNumber	String	Hashed Identity Number Of the Record (Only in Individual)
HashedPassportNumber	String	Hashed Passport Number Of the Record (Only in Individual)
Source	String	Created Source (Web Or Api)
OrganizationName	String	Organization Name
ReferenceNumber	String	Reference Number Of Record
Description	String	Description Of Record
Guid	String	Guid Of Queried Record
CreatedDate	DateTime	Created Date
CreatedUserName	String	Created User Name
ModifiedDate	DateTime	Modified Date
ModifiedUserName	String	Modified User Name

https://api.sanctionscanner.com/api/GeneralWhiteList/GetWhiteListById?guid=Guid

In the link above, a call must be made using the guid of the Record to be queried instead of the field that is in the “Guid” field.

Sample Service Response Codes

 

//Request 
GET /api/WhiteList/GetWhiteListById?guid=

//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "Name": "",
        "IdentityNumber": "",
        "PassportNumber": "",
        "HashedIdentityNumber": "",
        "HashedPassportNumber": "",
        "Source": "",
        "OrganizationName": "",
        "ReferenceNumber": "",
        "Description": "",
        "Guid": "",
        "CreatedDate": "",
        "CreatedUserName": "",
        "ModifiedDate": "",
        "ModifiedUserName": ""
    }
}

White List Update

Required input informations of UpdateWhiteList Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
https://api.sanctionscanner.com/api/GeneralWhiteList/UpdateWhiteList

This method is used to update the added white list. The “POST” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This method allows you to edit the record thay you have previously added to the system.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
TypeId	Integer	Yes	One of the following values must be sent; 1:Individual 2:Corporate 3:Vessel 4:Aircraft
Name	String	Yes	Name Of (Individual, Corporate, Vessel, Aircraft)
IdentityNumber	String	No	Identity Number Of Record (Only in Individual)
PassportNumber	String	No	Passport Number Of Record (Only in Individual)
ReferenceNumber	String	No	Reference Number
Description	String	No	Description
Guid	String	Yes	Guid

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
Name	String	Name Of Queried Record
IdentityNumber	String	Identity Number Of Queried Record
PassportNumber	String	Passport Number Of Queried Record
HashedIdentityNumber	String	Hashed Identity Number Of Queried Record
HashedPassportNumber	String	Hashed Passport Number Of Queried Record
Source	String	Created Source (Web Or Api)
OrganizationName	String	Organization Name
ReferenceNumber	String	Reference Number Of Record
Description	String	Description Of Record
Guid	String	Guid Of Queried Record
CreatedDate	DateTime	Created Date
CreatedUserName	String	Created User Name
ModifiedDate	DateTime	Modified Date
ModifiedUserName	String	Modified User Name

https://api.sanctionscanner.com/api/GeneralWhiteList/UpdateWhiteList

In the link above, a call is updated guid using the UpdateWhiteList.

Sample Service Response Codes

 

//Request 
      {
        "TypeId": 1,
        "Name": "",
        "IdentityNumber":"",
        "PassportNumber":"",
        "ReferenceNumber": "",
        "Description": "",
        "Guid": "",
      }


//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "Name": "",
        "IdentityNumber": "",
        "PassportNumber": "",
        "HashedIdentityNumber": "",
        "HashedPassportNumber": "",
        "Source": "",
        "OrganizationName": "",
        "ReferenceNumber": "",
        "Description": "",
        "Guid": "",
        "CreatedDate": "",
        "CreatedUserName": "",
        "ModifiedDate": "",
        "ModifiedUserName": ""
    }
}

White List Delete

Required input informations of DeleteWhiteList Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/GeneralWhiteList/DeleteWhiteList?guid=Guid

In the link above, a call must be made using the guid of the Record to be queried instead of the field that is in the “Guid” field.

This service is used to delete the added white list. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This service allows you to delete the record you have previously added to the system.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
guid	String	Yes	Guid of the Record

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information.

https://api.sanctionscanner.com/api/GeneralWhiteList/DeleteWhiteList?guid=

In the link above, a call is deleted guid using the DeleteWhiteList.

Sample Service Response Codes

 

//Request 
GET /api/WhiteList/DeleteWhiteList?guid=

//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": ""
}