Get My Organization Users
https://api.sanctionscanner.com/api/Operations/GetMyOrganizationUsers
This service allows you to list the users 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;
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
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. |
Parameter Name | Data Type | Description |
---|---|---|
UserGuidId | String | Guid Id Of User |
NameSurname | String | Name Surname Of User |
String | Email Address Of User |
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 Request Codes
//Request
GET /api/Operations/GetMyOrganizationUsers
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": [
{
"UserGuidId": "*****-*****-*****",
"NameSurname": "*******",
"Email": "*********"
},
{
"UserGuidId": "*****-*****-*****",
"NameSurname": "*******",
"Email": "*********"
}
]
}
Assign a User To a Search
https://api.sanctionscanner.com/api/Operations/AssignUserToSearch
This service is used to assign users to a search.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;
https://app.sanctionscanner.com/CaseManagement/Index
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ScanId | String | Yes | Scan Id Of Search (Example: D00001) |
UserGuidId | String | Yes | Guid Id Of User To Assign |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call must be made using AssignUserToSearch.
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 Request Codes
//Request
{
"scanId":"D0000000000",
"UserGuidId":"*****-*****-*****"
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Remove Assigned User From Search
https://api.sanctionscanner.com/api/Operations/RemoveAssignedUserFromSearch
This service is used to remove assigned user from search. 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;
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ScanId | String | Yes | Scan Id Of Search (Example: D00001) |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the RemoveAssignedUserFromSearch.
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 Request Codes
//Request
{
"scanId":"D0000000000",
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Set Search's Match Status
https://api.sanctionscanner.com/api/Operations/SetSearchMatchStatus
This service is used to set match status to a search. 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;
https://app.sanctionscanner.com/CaseManagement/Index
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ScanId | String | Yes | Scan Id Of Search (Example: D00001) |
StatusId | Integer | Yes |
Id Of Match Status
|
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the SetSearchMatchStatus.
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 Request Codes
//Request
{
"scanId":"D0000000000",
"StatusId":"0"
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Set Search's Risk Level
https://api.sanctionscanner.com/api/Operations/SetSearchRiskLevel
This service is used to set risk level to a search. 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;
https://app.sanctionscanner.com/CaseManagement/Index
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ScanId | String | Yes | Scan Id Of Search (Example: D00001) |
RiskLevelId | Integer | Yes |
Id Of Risk Level
|
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the SetSearchRiskLevel.
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 Request Codes
//Request
{
"scanId":"D0000000000",
"RiskLevelId":"0"
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Add Memo Notes To Search
https://api.sanctionscanner.com/api/Operations/AddMemoToSearch
This service is used to add memo to a search. 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;
https://app.sanctionscanner.com/CaseManagement/Index
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ScanId | String | Yes | Scan Id Of Search (Example: D00001) |
Memo | String | Yes | Text Of Memo |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the AddMemoToSearch.
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 Request Codes
//Request
{
"scanId":"D0000000000",
"Memo":"**************** *** ** **"
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Add Search To Safe List
https://api.sanctionscanner.com/api/Operations/SearchAddToSafeList
This service is used to add search result to safe 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;
https://app.sanctionscanner.com/CaseManagement/SafeList
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ScanId | String | Yes | Scan Id Of Search (Example: D00001) |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the SearchAddToSafeList.
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 Request Codes
//Request
{
"ScanId":"D0000000000"
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Delete Search From Safe List By Reference Number
https://api.sanctionscanner.com/api/Operations/DeleteFromSafeListByReferenceNumber
This service is used to remove search result from safe 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;
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ReferenceNumber | String | Yes | Reference Number Of Search |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the DeleteFromSafeListByReferenceNumber.
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 Request Codes
//Request
{
"ReferenceNumber":"************"
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Search Add To Safe List By DataId
https://api.sanctionscanner.com/api/Operations/SearchAddToSafeListByDataId
This service is used to add data to safe 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;
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ReferenceNumber | String | Yes | Reference Number Of Search |
DataList | List Of DataList Class | Yes | You can find the details in the table below. |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
SSID | String | Yes | SSID Of Search Data |
Type | String | Yes | Type Of Search Data |
EntityType | String | Yes | EntityType Of Search Data |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the SearchAddToSafeListByDataId.
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 Request Codes
//Request
{
"ReferenceNumber": "************",
"DataList" : [
{
"SSID" : "************",
"Type" : "Sanction",
"EntityType" : "Individual"
},
{
"SSID" : "************",
"Type" : "Pep",
"EntityType" : "Individual"
}
]
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Search Remove From Safe List By DataId
https://api.sanctionscanner.com/api/Operations/SearchRemoveFromSafeListByDataId
This service is used to remove data from safe 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;
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ReferenceNumber | String | Yes | Reference Number Of Search |
DataList | List Of DataList Class | Yes | You can find the details in the table below. |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
SSID | String | Yes | SSID Of Search Data |
Type | String | Yes | Type Of Search Data |
EntityType | String | Yes | EntityType Of Search Data |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the SearchRemoveFromSafeListByDataId.
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 Request Codes
//Request
{
"ReferenceNumber": "************",
"DataList" : [
{
"SSID" : "************",
"Type" : "Sanction",
"EntityType" : "Individual"
},
{
"SSID" : "************",
"Type" : "Pep",
"EntityType" : "Individual"
}
]
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Get My Organization Tags
https://api.sanctionscanner.com/api/Operations/GetMyOrganizationTags
This service allows you to list the tags 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;
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
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. |
Parameter Name | Data Type | Description |
---|---|---|
TagGuidId | String | GuidId Of Tag |
TagName | String | Name Of Tag |
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 Request Codes
//Request
GET /api/Operations/GetMyOrganizationTags
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": [
{
"TagGuidId": "*******",
"TagName": "*******",
},
{
"TagGuidId": "*******",
"TagName": "*******",
}
]
}
Add Tag To Search
https://api.sanctionscanner.com/api/Operations/AddTagToSearch
This service is used to set tags to a search. 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;
https://app.sanctionscanner.com/CaseManagement/Index
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ScanId | String | Yes | Scan Id Of Search (Example: D00001) |
TagGuidId | String | Yes | GuidId Of Tag |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the AddTagToSearch.
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 Request Codes
//Request
{
"scanId":"D0000000000",
"TagGuidId": "*******"
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Remove Tag From Search
https://api.sanctionscanner.com/api/Operations/RemoveTagFromSearch
This service is used to remove tags from search. 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;
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ScanId | String | Yes | Scan Id Of Search (Example: D00001) |
TagGuidId | String | Yes | GuidId Of Tag |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
ErrorCode | String |
Error Code |
ErrorMessage | String |
Error Message |
ExtraInfo | String |
Extra Information |
Result | String |
Result Message |
In the above link, a call is updated guid using the RemoveTagFromSearch.
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 Request Codes
//Request
{
"scanId":"D0000000000",
"TagGuidId": "*******"
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null
}
Get Search Tags By ScanId
https://api.sanctionscanner.com/api/Operations/GetSearchTagsByScanId
This service allows you to list all the tags in your search. When calling for service, the "GET" method should be used. In addition, the "user name" and "password" information required for the service should be sent as "Authorization" information via the "title". Service call should be made as follows;
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
username | String | Yes | Api Username Info |
password | String | Yes | Api Password Info |
Parameter Name | Data Type | Requriment | Description |
---|---|---|---|
ScanId | String | Yes | Scan Id Of Search (Example: D00001) |
Parameter Name | Data Type | Description |
---|---|---|
HttpStatusCode | Int |
Transaction Result Code 200: Success 400: Unsuccess |
IsSuccess | Boolean |
Transaction Result True: Success False: Unsuccess |
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. |
Parameter Name | Data Type | Description |
---|---|---|
TagGuidId | String | GuidId Of Tag |
TagName | String | Name Of Tag |
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 Request Codes
//Request
GET /api/Operations/GetSearchTagsByScanId?ScanId=
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": [
{
"TagGuidId": "*******",
"TagName": "*******",
},
{
"TagGuidId": "*******",
"TagName": "*******",
}
]
}