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;

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

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;

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

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;

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

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;

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

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;

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

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;

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

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;

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

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;

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

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

Sample Service Response Codes

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

Remove Scan

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

Sample Service Response Codes

 
                                          
//Request
{
    "scanId":"D0000000000",
}
//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;

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

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;

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

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;

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

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;

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

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;

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

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;

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

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;

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

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;

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

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;

Monitoring Disable

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;