Customer Methods | Sanction Scanner Developer Portal

Get Customer

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

This method allows for obtaining user information through CustomerId or Customer Number data. 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
customerId	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Identifier For The Customer Record
customerNumber	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Reference Number Used To Identify The Customer

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
CustomerID	Integer	Unique Identifier For The Customer
CustomerNumber	String	The Unique Number Assigned To The Customer
CustomerTypeId	Integer	The Type ID Of The Customer
CustomerName	String	The Full Name Of The Customer
CustomerStatus	Integer	The Current Status Of The Customer 1:New 2:Reviewed 3:Monitoring 4:Suspended 5:Terminated 6:Terminated And Reported
RiskScore	Integer	The Risk Score Associated With The Customer
RiskLevelID	Integer	The Risk Level ID Associated With The Customer
IsBlackList	Boolean	Indicates If The Customer Is Blacklisted
BlackListExpiredDate	DateTime	The Expiration Date Of The Blacklist Status
IsWhiteList	Boolean	Indicates If The Customer Is Whitelisted
WhiteListExpiredDate	DateTime	The Expiration Date Of The Whitelist Status
optionalParameters	optionalParameters Class	optionalParameters Information. The following internal table describes the internal parameters.

optionalParameters Class Informations

Parameter Name	Data Type	Description
Key	String	The Key For The Optional Parameter
Value	String	The Value Associated With The Optional Parameter Key

https://api.sanctionscanner.com/api/Customer/GetCustomer

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

//Response
{
  "HttpStatusCode": 200,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerID": 0,
    "CustomerNumber": "*****",
    "CustomerTypeId": 0,
    "CustomerName": "*****",
    "CustomerStatus": 0,
    "RiskScore": 0,
    "RiskLevelID": 0,
    "IsBlackList": true,
    "BlackListExpiredDate": "DateTime",
    "IsWhiteList": true,
    "WhiteListExpiredDate": "DateTime",
    "optionalParameters": [
      {
        "Key": "*****",
        "Value": "*****"
      }
    ]
  }
}

Add New Customer

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

This method allows creating a new customer in Individual, Entity/Organization or Private types after providing the necessary information. 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
CustomerNumber	String	Yes	A Unique Reference Number Used To Identify The Customer
CustomerName	String	No	The Full Name Of The Customer
CustomerTypeId	Integer	No	The Type ID Assigned To The Customer
CustomerStatus	Integer	No	The Current Status Of The Customer 1:New 2:Reviewed 3:Monitoring 4:Suspended 5:Terminated 6:Terminated And Reported
optionalParameters	optionalParameters Class	No	optionalParameters Information. The following internal table describes the internal parameters.

optionalParameters Class Informations

Parameter Name	Data Type	Description
Key	String	The Key For The Optional Parameter
Value	String	The Value Associated With The Optional Parameter Key

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
CustomerID	Integer	Unique Identifier For The Customer
CustomerNumber	String	The Unique Number Assigned To The Customer
CustomerTypeId	Integer	The Type ID Of The Customer
CustomerName	String	The Full Name Of The Customer
CustomerStatus	Integer	The Current Status Of The Customer 1:New 2:Reviewed 3:Monitoring 4:Suspended 5:Terminated 6:Terminated And Reported
RiskScore	Integer	The Risk Score Associated With The Customer
RiskLevelID	Integer	The Risk Level ID Associated With The Customer
IsBlackList	Boolean	Indicates If The Customer Is Blacklisted
BlackListExpiredDate	DateTime	The Expiration Date Of The Blacklist Status
IsWhiteList	Boolean	Indicates If The Customer Is Whitelisted
WhiteListExpiredDate	DateTime	The Expiration Date Of The Whitelist Status
optionalParameters	optionalParameters Class	optionalParameters Information. The following internal table describes the internal parameters.

optionalParameters Class Informations

Parameter Name	Data Type	Description
Key	String	The Key For The Optional Parameter
Value	String	The Value Associated With The Optional Parameter Key

https://api.sanctionscanner.com/api/Customer/AddNewCustomer

Sample Service Response Codes

 

//Request 
POST /api/Customer/AddNewCustomer

//Response
{
  "HttpStatusCode": 100,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerID": 0,
    "CustomerNumber": "*****",
    "CustomerTypeId": 0,
    "CustomerName": "*****",
    "CustomerStatus": 0,
    "RiskScore": 0,
    "RiskLevelID": 0,
    "IsBlackList": true,
    "BlackListExpiredDate": "DateTime",
    "IsWhiteList": true,
    "WhiteListExpiredDate": "DateTime",
    "optionalParameters": [
      {
        "Key": "*****",
        "Value": "*****"
      }
    ]
  }
}

Update Customer

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

This method allows you to edit the customer when a change occurs to customer information. 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
CustomerID	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	Unique Identifier For The Customer
CustomerNumber	String	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Reference Number Used To Identify The Customer
CustomerName	String	No	The Full Name Of The Customer
CustomerStatus	Integer	No	The Current Status Of The Customer 1:New 2:Reviewed 3:Monitoring 4:Suspended 5:Terminated 6:Terminated And Reported
optionalParameters	optionalParameters Class	No	optionalParameters Information. The following internal table describes the internal parameters.

optionalParameters Class Informations

Parameter Name	Data Type	Description
Key	String	The Key For The Optional Parameter
Value	String	The Value Associated With The Optional Parameter Key

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
CustomerID	Integer	Unique Identifier For The Customer
CustomerNumber	String	The Unique Number Assigned To The Customer
CustomerTypeId	Integer	The Type ID Of The Customer
CustomerName	String	The Full Name Of The Customer
CustomerStatus	Integer	The Current Status Of The Customer 1:New 2:Reviewed 3:Monitoring 4:Suspended 5:Terminated 6:Terminated And Reported
RiskScore	Integer	The Risk Score Associated With The Customer
RiskLevelID	Integer	The Risk Level ID Associated With The Customer
IsBlackList	Boolean	Indicates If The Customer Is Blacklisted
BlackListExpiredDate	DateTime	The Expiration Date Of The Blacklist Status
IsWhiteList	Boolean	Indicates If The Customer Is Whitelisted
WhiteListExpiredDate	DateTime	The Expiration Date Of The Whitelist Status
optionalParameters	optionalParameters Class	optionalParameters Information. The following internal table describes the internal parameters.

optionalParameters Class Informations

Parameter Name	Data Type	Description
Key	String	The Key For The Optional Parameter
Value	String	The Value Associated With The Optional Parameter Key

https://api.sanctionscanner.com/api/Customer/UpdateCustomer

Sample Service Response Codes

 

//Request 
POST /api/Customer/UpdateCustomer

//Response
{
  "HttpStatusCode": 100,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerID": 0,
    "CustomerNumber": "*****",
    "CustomerTypeId": 0,
    "CustomerName": "*****",
    "CustomerStatus": 0,
    "RiskScore": 0,
    "RiskLevelID": 0,
    "IsBlackList": true,
    "BlackListExpiredDate": "DateTime",
    "IsWhiteList": true,
    "WhiteListExpiredDate": "DateTime",
    "optionalParameters": [
      {
        "Key": "*****",
        "Value": "*****"
      }
    ]
  }
}

Delete Customer

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

This method allows you to delete a customer from the system by Customer Id or Customer Number. 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
customerId	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Identifier For The Customer Record
customerNumber	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Reference Number Used To Identify The Customer

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

Sample Service Response Codes

 

//Request 
GET /api/Customer/DeleteCustomer

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

Get Customer Risk Score

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

This method allows you to get customer risk score from system by Customer Id or Customer Number. 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
customerId	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Identifier For The Customer Record
customerNumber	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Reference Number Used To Identify The Customer

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
CustomerId	Integer	Unique Identifier For The Customer
NameSurname	String	The Full Name Of The Customer
CustomerNumber	String	The Unique Number Assigned To The Customer
CustomerTypeId	Integer	The Type ID Of The Customer
IsBlackList	Boolean	Indicates If The Customer Is Blacklisted
BlackListExpiredDate	DateTime	The Expiration Date Of The Blacklist Status
IsWhiteList	Boolean	Indicates If The Customer Is Whitelisted
WhiteListExpiredDate	DateTime	The Expiration Date Of The Whitelist Status
StatusId	Integer	The Current Status Of The Customer 1:New 2:Reviewed 3:Monitoring 4:Suspended 5:Terminated 6:Terminated And Reported
CustomerRiskScore	Integer	The Risk Score Associated With The Customer
RiskLevelId	Integer	The Risk Level Associated With The Customer
ModifiedDate	DateTime	The Date When The Customer Record Was Last Modified

https://api.sanctionscanner.com/api/Customer/GetCustomerRiskScore

Sample Service Response Codes

 

//Request 
GET /api/Customer/GetCustomerRiskScore

//Response
{
  "HttpStatusCode": 200,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerId": 0,
    "NameSurname": "*****",
    "CustomerNumber": "*****",
    "CustomerTypeId": 0,
    "IsBlackList": true,
    "BlackListExpiredDate": "DateTime",
    "IsWhiteList": true,
    "WhiteListExpiredDate": "DateTime",
    "StatusId": 0,
    "CustomerRiskScore": 0,
    "RiskLevelId": 0,
    "ModifiedDate": "DateTime"
  }
}

Add Customer Risk Score

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

This method allows you to add/subtract score to customer risk score from system by Customer Id or Customer Number. 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
CustomerID	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Identifier For The Customer Record
CustomerNumber	String	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Reference Number Used To Identify The Customer
AdditionalRiskScore	Integer	No	The Additional Risk Score Assigned To The Customer
Description	String	No	A Description Associated With The Customer's Risk Or Status

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
CustomerID	Integer	The Unique Identifier For The Customer Record
CustomerNumber	String	The Unique Reference Number Used To Identify The Customer
CustomerTypeId	Integer	The Type ID Of The Customer
CustomerName	String	The Full Name Of The Customer
CustomerStatus	Integer	The Current Status Of The Customer 1:New 2:Reviewed 3:Monitoring 4:Suspended 5:Terminated 6:Terminated And Reported
RiskScore	Integer	The Risk Score Assigned To The Customer
RiskLevelID	Integer	The Risk Level ID Assigned To The Customer

https://api.sanctionscanner.com/api/Customer/AddCustomerRiskScore

Sample Service Response Codes

 

//Request 
POST /api/Customer/AddCustomerRiskScore

//Response
{
  "HttpStatusCode": 100,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerID": 0,
    "CustomerNumber": "*****",
    "CustomerTypeId": 0,
    "CustomerName": "*****",
    "CustomerStatus": 0,
    "RiskScore": 0,
    "RiskLevelID": 0
  }
}

Get My Dynamic Fields

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

This method allows you to get your all dynamic fields. 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	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
DynamicFields	DynamicFields Class	Dynamic Fields Information. The following internal table describes the internal parameters.

DynamicFields Class Informations

Parameter Name	Data Type	Description
Key	String	The Key Of The Dynamic Field
DisplayName	String	The Display Name For The Dynamic Field
DataTypeId	Integer	The Data Type ID Of The Dynamic Field
DataTypeName	String	The Name Of The Data Type For The Dynamic Field
FieldTypeId	Integer	The Field Type ID For The Dynamic Field
FieldTypeName	String	The Field Type Name For The Dynamic Field
Options	Options Class	Options Information. The following internal table describes the internal parameters.

Options Class Informations

Parameter Name	Data Type	Description
Key	String	The Key Of The Option
Name	String	The Name Of The Option
Description	String	A Description Of The Option

https://api.sanctionscanner.com/api/Customer/GetMyDynamicFields

Sample Service Response Codes

 

//Request 
GET /api/Customer/GetMyDynamicFields

//Response
{
  "HttpStatusCode": 200,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "DynamicFields": [
      {
        "Key": "*****",
        "DisplayName": "*****",
        "DataTypeId": 0,
        "DataTypeName": "*****",
        "FieldTypeId": 0,
        "FieldTypeName": "*****",
        "Options": [
          {
            "Key": "*****",
            "Name": "*****",
            "Description": "*****"
          }
        ]
      }
    ]
  }
}

Get Customer Score History

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

This method allows you to get customer score history from system by Customer Id or Customer Number. 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	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
customerId	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Identifier For The Customer Record
customerNumber	String	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	A Unique Reference Number Used To Identify The Customer
startDate	DateTime	No	The Start Date For The Relevant Activity Or Period
endDate	DateTime	No	The End Date For The Relevant Activity Or Period

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
CustomerID	Integer	The Unique Identifier For The Customer Record
CustomerNumber	String	The Unique Reference Number Used To Identify The Customer
RiskScoreHistory	RiskScoreHistory Class	Risk Score History Information. The following internal table describes the internal parameters.

RiskScoreHistory Class Informations

Parameter Name	Data Type	Description
Date	String	The Date When The Risk Score Was Recorded
RiskScore	Integer	The Risk Score Assigned To The Customer On The Given Date
Description	String	A Description Or Reason Associated With The Risk Score On That Date

https://api.sanctionscanner.com/api/Customer/GetCustomerScoreHistory

Sample Service Response Codes

 

//Request 
GET /api/Customer/GetCustomerScoreHistory

//Response
{
  "HttpStatusCode": 200,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerID": 0,
    "CustomerNumber": "*****",
    "RiskScoreHistory": [
      {
        "Date": "DateTime",
        "RiskScore": 0,
        "Description": "*****"
      }
    ]
  }
}

Add Customer To BlackList

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

This method allows you to add customer to blacklist. 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
CustomerID	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	The Unique Identifier For The Customer Record
CustomerNumber	String	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	The Unique Reference Number Used To Identify The Customer
BlackListExpirationDate	DateTime	No	The Date When The Customer's Blacklist Status Expires
Reason	String	No	The Reason For The Customer Being Added To The Blacklist
IsAddRiskScore	Boolean	No	Indicates Whether A Risk Score Should Be Added To The Customer
BlackListRiskScore	Integer	No	The Risk Score Associated With The Customer's Blacklist Status

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
CustomerID	Integer	The Unique Identifier For The Customer Record
CustomerNumber	String	The Unique Reference Number Used To Identify The Customer
BlackListExpirationDate	DateTime	The Date When The Customer's Blacklist Status Expires
BlackListRiskScore	Integer	The Risk Score Associated With The Customer's Blacklist Status
Message	String	A Message Related To The Customer's Blacklist Status

https://api.sanctionscanner.com/api/Customer/AddCustomerToBlackList

Sample Service Response Codes

 

//Request 
POST /api/Customer/AddCustomerToBlackList

//Response
{
  "HttpStatusCode": 200,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerID": 0,
    "CustomerNumber": "*****",
    "BlackListExpirationDate": "DateTime",
    "BlackListRiskScore": 0,
    "Message": "*****"
  }
}

Remove Customer From BlackList

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

This method allows you to remove customer from the blacklist. 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
CustomerID	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	The Unique Identifier For The Customer Record
CustomerNumber	String	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	The Unique Reference Number Used To Identify The Customer
Reason	String	No	The Reason For The Customer's Blacklist Removal

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
CustomerID	Integer	The Unique Identifier For The Customer Record
CustomerNumber	String	The Unique Reference Number Used To Identify The Customer
Message	String	A Message Related To The Customer's Status

https://api.sanctionscanner.com/api/Customer/RemoveCustomerFromBlackList

Sample Service Response Codes

 

//Request 
POST /api/Customer/RemoveCustomerFromBlackList

//Response
{
  "HttpStatusCode": 200,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerID": 0,
    "CustomerNumber": "*****",
    "Message": "*****"
  }
}

Add Customer To WhiteList

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

This method allows you to add customer to whitelist. 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
CustomerID	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	The Unique Identifier For The Customer Record
CustomerNumber	String	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	The Unique Reference Number Used To Identify The Customer
WhiteListExpirationDate	DateTime	No	The Date When The Customer's Whitelist Status Expires
Reason	String	No	The Reason For The Customer Being Added To The Blacklist

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
CustomerID	Integer	The Unique Identifier For The Customer Record
CustomerNumber	String	The Unique Reference Number Used To Identify The Customer
WhiteListExpirationDate	DateTime	The Date When The Customer's Whitelist Status Expires
Message	String	A Message Related To The Customer's Whitelist Status

https://api.sanctionscanner.com/api/Customer/AddCustomerToWhiteList

Sample Service Response Codes

 

//Request 
POST /api/Customer/AddCustomerToWhiteList

//Response
{
  "HttpStatusCode": 200,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerID": 0,
    "CustomerNumber": "*****",
    "WhiteListExpirationDate": "DateTime",
    "Message": "*****"
  }
}

Remove Customer From WhiteList

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

This method allows you to remove customer from the whitelist. 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
CustomerID	Integer	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	The Unique Identifier For The Customer Record
CustomerNumber	String	No (If Neither CustomerID Nor CustomerNumber Is Provided, An Error Will Be Returned)	The Unique Reference Number Used To Identify The Customer
Reason	String	No	The Reason For The Customer's Whitelist Removal

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
CustomerID	Integer	The Unique Identifier For The Customer Record
CustomerNumber	String	The Unique Reference Number Used To Identify The Customer
Message	String	A Message Related To The Customer's Status

https://api.sanctionscanner.com/api/Customer/RemoveCustomerFromWhiteList

Sample Service Response Codes

 

//Request 
POST /api/Customer/RemoveCustomerFromWhiteList

//Response
{
  "HttpStatusCode": 200,
  "IsSuccess": true,
  "ErrorCode": "*****",
  "ErrorMessage": "*****",
  "ExtraInfo": "*****",
  "Result": {
    "CustomerID": 0,
    "CustomerNumber": "*****",
    "Message": "*****"
  }
}