Get My Organization Users

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;

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  ***** HTTP/1.1
Host: *****.com
Authorization: Basic OTM1Nzk4OGUtNzA4Zi00MGQ3LWIyODktNzY3M2U1MDc4MWVkOkszWXE1VWkxYWc=
Cache-Control: no-cache

//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

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;

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.

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",
	"userId":"0"
}


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

Set Search's Match Status

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;

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.

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

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;

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

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.

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

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;

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.

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

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;

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.

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

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.

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
}