Search Operations | 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	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
UserGuidId	String	Unique Guid 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 Response 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

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://appv2.sanctionscanner.com/CaseManagement/Index

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
ScanId	String	Yes	Scan Id Of Search (Example: D0000001)
UserGuidId	String	Yes	Guid Id Of User To Assign

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	String	Result Message

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

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

Sample Service Response Codes

 

//Request 
    {
	"scanId":"D0000000000",
	"UserGuidId":"*****-*****-*****"
}


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

Assign a User To Batch Search

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

This service is used to assign users to a batch search as bulk. With this API, all related searches in this batch assigned to the user. 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
BatchId	String	Yes	Batch Id Of Batch Search (Example: BS00001)
UserGuidId	String	Yes	Guid Id Of User To Assign

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	String	Result Message

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

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

Sample Service Response Codes

 

//Request 
    {
	"BatchId":"BS0000000000",
	"UserGuidId":"*****-*****-*****"
}


//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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

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

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	String	Result Message

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

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

Sample Service Response 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://appv2.sanctionscanner.com/CaseManagement/Index

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
ScanId	String	Yes	Scan Id Of Search (Example: D00000001)
StatusId	Integer	No	Id Of Match Status (Default: 0) 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: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
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 link above, a call is updated guid using the SetSearchMatchStatus.

Sample Service Response 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://appv2.sanctionscanner.com/CaseManagement/Index

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
ScanId	String	Yes	Scan Id Of Search (Example: D00000001)
RiskLevelId	Integer	No	Id Of Risk Level (Default: 0) 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: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
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 link above, a call is updated guid using the SetSearchRiskLevel.

Sample Service Response 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. You can follow the process of assigning the user from the "Case Management" screen in the link below.

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

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
ScanId	String	Yes	Scan Id Of Search (Example: D0000001)
Memo	String	Yes	Text Of Memo

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	String	Result Message

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

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

Sample Service Response Codes

 

//Request 
    {
	"scanId":"D0000000000",
	"Memo":"**************** *** ** **"
}


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

Get Memo List By Scan Id

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

This service is used to get memos of a search. 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;

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

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

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
ScanId	String	Yes	Scan Id Of Search (Example: D0000001)

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	String	Result Message

https://api.sanctionscanner.com/api/Operations/GetMemoListByScanId?scanId=ScanId

Sample Service Response Codes



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

//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null,
"ScanId": null,
"MemoList": [
    {
        "MemoId": "*******",
        "Memo": "*******",
    },
    {
        "MemoId": "*******",
        "Memo": "*******",
    }
    ]
}

Remove Memo By Scan

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

This service is used to remove a memo from a search. 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;

You can remove memo notes from a search that you performed. You can follow the process of assigning the user from the "Case Management" screen in the link below.

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

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
MemoId	String	Yes	Memo Id Of Search (Example: 1234)

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	String	Result Message

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

In the link above, a call is updated guid using the RemoveMemoByScan

Sample Service Response Codes

 
                                          
//Request GET /api/Operations/RemoveMemoByScan 

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

Remove Scan

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

This service is used to remove a search. 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;

You can remove searches that you performed. You can follow the process of assigning the user from the "Case Management" screen in the link below.

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

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
ScanId	String	Yes	Id Of Scan (Example: "scanId":"D0000000000")

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	String	Result Message

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

In the link above, a call is updated guid using the Remove Scan

Sample Service Response Codes

 
                                          
//Request GET /api/Operations/RemoveScan

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

Get Close Case Reasons

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

This service allows all close reasons in your organization to be listed along with their ReasonId, Description and Guid information. You can use the ReasonIds of the close reasons that you will obtain by using this service in close case operation.

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
ReasonId	Int	Reason Id of close reason
Description	String	Description of close reason
Guid	String	Guid of close reason

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

Sample Service Response Codes

 

//Request 
GET /api/Operations/GetMyOrganizationCloseReasons

//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": [
        {
            "ReasonId": 1,
            "Description": "*******",
            "Guid": "*****-*****-*****",
        },
        {
            "ReasonId": 1,
            "Description": "*******",
            "Guid": "*****-*****-*****",
        }
    ]
}

Close Case By ScanId

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

This service is used to close case. 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
ScanId	String	Yes	Id Of Scan (Example: "scanId":"D0000000000")
ReasonId	Integer	No	Id Of Reason 1: Confirmed False Positive: No actions required. 2: Confirmed True Positive: The action has been taken. 3: Unconfirmed: The customer didn't onboarded. You can access reasons from "GetMyOrganizationCloseReasons" method
Description	String	No	Case Closing 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	String	Result Message

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

Sample Service Response Codes

 


//Request 
{
  "ScanId": "D000000001",
  "ReasonId": 1,
  "Description": "string"
}

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

ReOpen Case By ScanId

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

This service is used to reopen case. 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
ScanId	String	Yes	Id Of Scan (Example: "scanId":"D0000000000")
Description	String	No	Case Reopening 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	String	Result Message

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

Sample Service Response Codes

 


//Request 
{
  "ScanId": "D000000001",
  "Description": "string"
}

//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://appv2.sanctionscanner.com/CaseManagement/SafeList

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
ScanId	String	Yes	Scan Id Of Search (Example: D00000001)

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	String	Result Message

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

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

Sample Service Response 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

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

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	String	Result Message

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

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

Sample Service Response 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
ReferenceNumber	String	Yes	Scan Id Of Search (Example: D00000001)
DataList	List Of DataList Class	Yes	You can find the details in the table below.

DataList Class

Parameter Name	Data Type	Requirement	Description
SSID	String	Yes	SSID (Unique Id Of Data) of related data in scan result
Type	String	Yes	Type of related data in scan result (Ex. Values: Sanction, Wanted, Watchlist, PEP, SIP, Local)
EntityType	String	Yes	EntityType of related data in scan result (Ex. Values: Individual, Corporate, Vessel, Aircraft)

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	String	Result Message

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

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

Sample Service Response 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
ReferenceNumber	String	Yes	Scan Id Of Search (Example: D00000001)
DataList	List Of DataList Class	Yes	You can find the details in the table below.

DataList Class

Parameter Name	Data Type	Requirement	Description
SSID	String	Yes	SSID (Unique Id Of Data) of related data in scan result
Type	String	Yes	Type of related data in scan result (Ex. Values: Sanction, Wanted, Watchlist, PEP, SIP, Local)
EntityType	String	Yes	EntityType of related data in scan result (Ex. Values: Individual, Corporate, Vessel, Aircraft)

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	String	Result Message

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

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

Sample Service Response 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	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
TagGuidId	String	Guid Id Of Tag
TagName	String	Name Of Tag

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

Sample Service Response 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

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://appv2.sanctionscanner.com/CaseManagement/Index

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
ScanId	String	Yes	Scan Id Of Search (Example: D00000001)
TagGuidId	String	Yes	Guid Id Of Tag

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	String	Result Message

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

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

Sample Service Response Codes

 

//Request 
    {
	"scanId":"D0000000000",
    "TagGuidId": "*******"
}


//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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
ScanId	String	Yes	Scan Id Of Search (Example: D00000001)
TagGuidId	String	Yes	Guid Id Of Tag

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	String	Result Message

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

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

Sample Service Response Codes

 

//Request 
{
	"scanId":"D0000000000",
	"TagGuidId": "*******"
}


//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&ScanId=ScanId

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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

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

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
TagGuidId	String	Guid Id Of Tag
TagName	String	Name Of Tag

https://api.sanctionscanner.com/api/Operations/GetSearchTagsByScanId&ScanId=ScanId

Sample Service Response Codes


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

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

Monitoring Enable

Required input information of MonitoringEnable Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.

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

This service is used to set as Ongoing Monitoring status enabled to a search that you've performed. 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 ensures that all tags in your search are listed.

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
scanId	String	Yes	Scan Id Of Search (Example: D0000001)
periodId	String	No	Period Info (Default : 1) 1:Daily 2:Weekly 3:Monthly 4:Quarterly 5:HalfEarly 6:Yearly

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	String	Result Information

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

Monitoring Disable

Required input information of MonitoringDisable Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.

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

This service is used to set as Ongoing Monitoring status disabled to a search that you've performed. 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 ensures that all tags in your search are listed.

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
scanId	String	Yes	Scan Id Of Search (Example: D0000001)

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	String	Result Information

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