Creating A Simple Whitelisting Request

Basic Description

This endpoint is used to create a Whitelisting Request in Taurus-PROTECT. To understand more about Whitelisting, please refer to the following page in the Taurus User Guides.

This endpoint would accept a POST Request with a JSON payload containing the Whitelisting Request details. The blockchain,labeland address are the only three required parameters that must be included within the JSON payload.

Prerequisites

Required Roles

Certain API endpoints require that the user has a specific role in order to access them. Roles are used to restrict access to certain functionality within the system and ensure that only authorized users are able to perform specific actions.

Here is the list of required Roles for this particular endpoint:

• WhitelistedAddressCreator
• TPUser

To find out more about roles, please refer to the following page in the Taurus User Guides.

Required Input Parameters

Certain API endpoints require specific input parameters. Here is the list of Required Input Parameters for this particular endpoint:

• blockchain: the blockchain used for the selected Αddress.
• label: the label of the selected Address to be whitelisted.
• address: the Address to be whitelisted.

📘

Preconditions

It is important to note that the selected currency needs to be active in the system.
For example, If you haven't enabled BTC in your HSM, you will not be able to whitelist an address on BTC.
In addition, the requested Address needs to follow the requirements and characteristics on the relevant blockchain for the Whitelisting Request to go through.

Call Example

You can find a basic example in cURL below.
Please note that you will need to update the BASEURL and the APITOKEN for the command to function.

export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/whitelists/addresses" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken" \
--data '{
  "blockchain": "ETH",
  "address": "0xb794f5ea0ba39494ce839613fffba74279579267",
  "label": "API-Documentation - Test 8"
}'

This piece of code sends a POST request to https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses with the JSON object in the request body.

👍

Call Result

A successful response for the POST call to create a simple whitelisting request might look like this:

{
    "result": {
        "id": "3711"
    }
}

In this example, Taurus-PROTECT has created a new Whitelisting Request with a unique ID of 3711. Taurus-PROTECT responds with a JSON object containing the newly assigned Requestid.

Please note that this Request will then need to be signed for the whitelisting process to go through.

Requirements for Future Use

For this particular endpoint, we need to store the Requestid as it will be required in the next steps where we will sign the Transaction Request.

You can find the Swagger-generated page for this endpoint in the following link.