Get White List By Id

This service is used to find out if the guid of the person entered is on the white list. The information required to perform the service call is the guid of the person to be interrogated. 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

Input Informations
Parameter Name Data Type Requriment Description
Guid String Yes

Guid Of Person To Query

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
Name String

Name Of Queried Person

IdentityNumber String

Identity Number Of Queried Person

PassportNumber String

Passport Number Of Queried Person

HashedIdentityNumber String

Hashed Identity Number Of Queried Person

HashedPassportNumber String

Hashed Passport Number Of Queried Person

Source String

Created Source (Web Or Api)

OrganizationName String

Organization Name

ReferenceNumber String

Reference Number Of Record

Description String

Description Of Record

Guid String

Guid Of Queried Person

CreatedDate DateTime

Created Date

CreatedUserName String

Created User Name

ModifiedDate DateTime

Modified Date

ModifiedUserName String

Modified User Name

https://api.sanctionscanner.com/api/WhiteList/GetWhiteListById?guid=Guid

In the above link, a call must be made using the guid of the person to be queried instead of the field that is in the “Guid” field.

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

//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "Name": "",
        "IdentityNumber": "",
        "PassportNumber": "",
        "HashedIdentityNumber": "",
        "HashedPassportNumber": "",
        "Source": "",
        "OrganizationName": "",
        "ReferenceNumber": "",
        "Description": "",
        "Guid": "",
        "CreatedDate": "",
        "CreatedUserName": "",
        "ModifiedDate": "",
        "ModifiedUserName": ""
    }
}
                    

New White List

This service is used to add a new white 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
Name String No

Name Of Person To Query

IdentityNumber String No

Identity Number Of Person To Query

PassportNumber String No

Passport Number Of Person To Query

ReferenceNumber String No

Reference Number Of Person To Query

Description String No

Description Of Person To Query

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
Name String

Name Of Queried Person

IdentityNumber String

Identity Number Of Queried Person

PassportNumber String

Passport Number Of Queried Person

HashedIdentityNumber String

Hashed Identity Number Of Queried Person

HashedPassportNumber String

Hashed Passport Number Of Queried Person

Source String

Created Source (Web Or Api)

OrganizationName String

Organization Name

ReferenceNumber String

Reference Number Of Record

Description String

Description Of Record

Guid String

Guid Of Queried Person

CreatedDate DateTime

Created Date

CreatedUserName String

Created User Name

ModifiedDate DateTime

Modified Date

ModifiedUserName String

Modified User Name

https://api.sanctionscanner.com/api/WhiteList/NewWhiteList

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

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 
      {
        "Name": "",
        "IdentityNumber":"",
        "PassportNumber":"",
        "ReferenceNumber": "",
        "Description": "",
      }


//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "Name": "",
        "IdentityNumber": "",
        "PassportNumber": "",
        "HashedIdentityNumber": "",
        "HashedPassportNumber": "",
        "Source": "",
        "OrganizationName": "",
        "ReferenceNumber": "",
        "Description": "",
        "Guid": "",
        "CreatedDate": "",
        "CreatedUserName": "",
        "ModifiedDate": "",
        "ModifiedUserName": ""
    }
}
                    

White List Update

This service is used to update the added white list. The information required to perform the service call is the guid of the person to be interrogated. 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
Name String No

Name Of Person To Query

IdentityNumber String No

Identity Number Of Person To Query

PassportNumber String No

Passport Number Of Person To Query

ReferenceNumber String No

Reference Number Of Person To Query

Description String No

Description Of Person To Query

Guid String Yes

Guid Of Queried Person

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
Name String

Name Of Queried Person

IdentityNumber String

Identity Number Of Queried Person

PassportNumber String

Passport Number Of Queried Person

HashedIdentityNumber String

Hashed Identity Number Of Queried Person

HashedPassportNumber String

Hashed Passport Number Of Queried Person

Source String

Created Source (Web Or Api)

OrganizationName String

Organization Name

ReferenceNumber String

Reference Number Of Record

Description String

Description Of Record

Guid String

Guid Of Queried Person

CreatedDate DateTime

Created Date

CreatedUserName String

Created User Name

ModifiedDate DateTime

Modified Date

ModifiedUserName String

Modified User Name

https://api.sanctionscanner.com/api/WhiteList/UpdateWhiteList

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

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 
      {
        "Name": "",
        "IdentityNumber":"",
        "PassportNumber":"",
        "ReferenceNumber": "",
        "Description": "",
        "Guid": "",
      }


//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "Name": "",
        "IdentityNumber": "",
        "PassportNumber": "",
        "HashedIdentityNumber": "",
        "HashedPassportNumber": "",
        "Source": "",
        "OrganizationName": "",
        "ReferenceNumber": "",
        "Description": "",
        "Guid": "",
        "CreatedDate": "",
        "CreatedUserName": "",
        "ModifiedDate": "",
        "ModifiedUserName": ""
    }
}
                    

White List Delete

This service is used to delete the added white list. The information required to perform the service call is the guid of the person to be interrogated. 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
guid String Yes

Guid Of Person To Query

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.

https://api.sanctionscanner.com/api/WhiteList/DeleteWhiteList?guid=

In the above link, a call is deleted guid using the DeleteWhiteList.

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

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