SearchOperations | Sanction Scanner Developer Portal

Get My Organization Users

Required input informations of GetMyOrganizationUsers Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
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;

This service allows all users in your organization to be listed along with their ID, name and email information. You can use the IDs of the users that you will obtain by using this service in other operations.

Token Informations

Parameter Name	Data Type	Requriment	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: 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.

Result Class Informations

Parameter Name	Data Type	Description
UserId	Integer	Id Of User
NameSurname	String	Name Surname Of User
Email	String	Email Address Of User

https://api.sanctionscanner.com/api/Operations/GetMyOrganizationUsers

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": [
        {
            "UserId": 0,
            "NameSurname": "*******",
            "Email": "*********"
        },
        {
            "UserId": 0,
            "NameSurname": "*******",
            "Email": "*********"
        }
    ]
}

Assign a User To a Search

Required input informations of AssignUserToSearch Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

This method is used to assign a search result that you have already made to any user in your organization. You must use the "Get My Organization Users" method to obtain users' IDs. You can follow the process of assigning the user from the "Case Management" screen in the link below.

https://app.sanctionscanner.com/CaseManagement/Index

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00001)
UserId	Integer	Yes	Id Of User To Assign

Output Informations

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

https://api.sanctionscanner.com/api/Operations/AssignUserToSearch

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

Sample Service Request Codes

 

//Request 
    {
	"scanId":"D0000000000",
	"userId":"0"
}


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

Remove Assigned User From Search

Required input informations of RemoveAssignedUserFromSearch Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

This method allows you to remove a person assigned to the call.

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00001)

Output Informations

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

https://api.sanctionscanner.com/api/Operations/RemoveAssignedUserFromSearch

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

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

Required input informations of SetSearchMatchStatus Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

This service is used to set a match status to a search that you've performed. Match status options are specified in the following input parameters. You can follow the process of setting the match status from the "Case Management" screen in the link below.

https://app.sanctionscanner.com/CaseManagement/Index

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00001)
StatusId	Integer	Yes	Id Of Match Status 0:Unknown 1:No Match 2:Potential Match 3:False Positive 4:True Positive 5:True Positive Approve 6:True Positive Reject

Output Informations

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

https://api.sanctionscanner.com/api/Operations/SetSearchMatchStatus

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

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

Required input informations of SetSearchRiskLevel Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

This service is used to set a Risk Level to a search that you've performed. Risk level options are specified in the following input parameters. You can follow the process of setting the match status from "Case Management" screen in the link below.

https://app.sanctionscanner.com/CaseManagement/Index

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00001)
RiskLevelId	Integer	Yes	Id Of Risk Level 0:Unknown 1:Low 2:Medium 3:High 4:Neutral 5:Increased 6:Unacceptable

Output Informations

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

https://api.sanctionscanner.com/api/Operations/SetSearchRiskLevel

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

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

Required input informations of AddMemoToSearch Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

You can add memo notes to a search that you performed. Multiple memo notes can be added to the same search. You can follow the process of assigning the user from the "Case Management" screen in the link below.

https://app.sanctionscanner.com/CaseManagement/Index

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00001)
Memo	String	Yes	Text Of Memo

Output Informations

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

https://api.sanctionscanner.com/api/Operations/AddMemoToSearch

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

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

Required input informations of AddSearchToSafeList Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

This method is used to add a search that you have already performed on the safe list. The safe list is based on the "reference number" which you send on search. When a search result added to the safe list with a reference number, the same results from the new searches that using the same reference number will not show. Because the same results have already added before to safe lists in the same searches by you. However, with the update of the lists, new records can be added as a result and you will see these results on the search result page. You can follow your transactions on the "Case Management" screen in the link below.
https://app.sanctionscanner.com/CaseManagement/SafeList

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00001)

Output Informations

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

https://api.sanctionscanner.com/api/Operations/SearchAddToSafeList

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

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

Required input informations of DeleteFromSafeListByReferenceNumber Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ReferenceNumber	String	Yes	Reference Number Of Search

Output Informations

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

https://api.sanctionscanner.com/api/Operations/DeleteFromSafeListByReferenceNumber

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

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

Required input informations of SearchAddToSafeListByDataId Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

Token Informations

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

Input Informations

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.

DataList Class

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

Output Informations

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

https://api.sanctionscanner.com/api/Operations/SearchAddToSafeListByDataId

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

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

Required input informations of SearchRemoveFromSafeListByDataId Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

Token Informations

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

Input Informations

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.

DataList Class

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

Output Informations

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

https://api.sanctionscanner.com/api/Operations/SearchRemoveFromSafeListByDataId

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

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

Required input informations of GetMyOrganizationTags Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
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;

This service allows all organization tags in your organization to be listed along with their ID and name information.

Token Informations

Parameter Name	Data Type	Requriment	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: 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.

Result Class Informations

Parameter Name	Data Type	Description
TagId	Integer	Id Of Tag
TagName	String	Name Of Tag

https://api.sanctionscanner.com/api/Operations/GetMyOrganizationTags

Sample Service Request Codes


    
        //Request
        GET /api/Operations/GetMyOrganizationTags 

        //Response
        {
        "HttpStatusCode": 200,
        "IsSuccess": true,
        "ErrorCode": null,
        "ErrorMessage": null,
        "ExtraInfo": null,
        "Result": [
        {
        "TagId": 0,
        "TagName": "*******",
        },
        {
        "TagId": 0,
        "TagName": "*******",
        }
        ]
        }

Add Tag To Search

Required input informations of AddTagToSearch Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

This service is used to set a Organization Tags to a search that you've performed. Organization Tags options are specified in the following input parameters. You can follow the process of setting the organization tag from "Case Management" screen in the link below.

https://app.sanctionscanner.com/CaseManagement/Index

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00001)
TagId	Integer	Yes	Id Of Tag

Output Informations

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

https://api.sanctionscanner.com/api/Operations/AddTagToSearch

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

Sample Service Request Codes

 

//Request 
    {
	"scanId":"D0000000000",
	"TagId":"0"
}


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

Remove Tag From Search

Required input informations of RemoveTagFromSearch Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
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;

This method allows to remove an assigned organization tags.

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00001)
TagId	Integer	Yes	Id of Tag

Output Informations

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

https://api.sanctionscanner.com/api/Operations/RemoveTagFromSearch

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

Sample Service Request Codes

 

//Request 
{
	"scanId":"D0000000000",
	"TagId":"0"
}


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

Get Search Tags By ScanId

Required input informations of GetSearchTagsByScanId Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
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;

This service ensures that all tags in your search are listed.

Token Informations

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

Input Informations

Parameter Name	Data Type	Requriment	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00001)

Output Informations

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.

Result Class Informations

Parameter Name	Data Type	Description
TagId	Integer	Id Of Tag
TagName	String	Name Of Tag

https://api.sanctionscanner.com/api/Operations/GetSearchTagsByScanId

Sample Service Request Codes


    
        //Request
        GET /api/Operations/GetSearchTagsByScanId?ScanId=

        //Response
        {
        "HttpStatusCode": 200,
        "IsSuccess": true,
        "ErrorCode": null,
        "ErrorMessage": null,
        "ExtraInfo": null,
        "Result": [
        {
        "TagId": 0,
        "TagName": "*******",
        },
        {
        "TagId": 0,
        "TagName": "*******",
        }
        ]
        }