> This page is for Taurus PROTECT, version v3.38.
> For other versions, use one of these documentation indexes:
> - v3.58 (default): https://taurushq.ferndocs.com/protect-capital/v3.58/llms.txt
> - v3.56: https://taurushq.ferndocs.com/protect-capital/v3.56/llms.txt
> - v3.54: https://taurushq.ferndocs.com/protect-capital/v3.54/llms.txt
> - v3.52: https://taurushq.ferndocs.com/protect-capital/v3.52/llms.txt
> - v3.50: https://taurushq.ferndocs.com/protect-capital/v3.50/llms.txt
> - v3.48: https://taurushq.ferndocs.com/protect-capital/v3.48/llms.txt
> - v3.46: https://taurushq.ferndocs.com/protect-capital/v3.46/llms.txt
> - v3.44: https://taurushq.ferndocs.com/protect-capital/v3.44/llms.txt
> - v3.42: https://taurushq.ferndocs.com/protect-capital/v3.42/llms.txt
> - v3.40: https://taurushq.ferndocs.com/protect-capital/v3.40/llms.txt
> - v3.38: https://taurushq.ferndocs.com/protect-capital/v3.38/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://taurushq.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://taurushq.ferndocs.com/_mcp/server.

# Create a whitelisted address

POST https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses
Content-Type: application/json

This endpoint creates a new whitelisted address.
 Required role: **WhitelistedAddressCreator**.

Reference: https://taurushq.ferndocs.com/protect-capital/reference/whitelisted-addresses/create

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a tgvalidatordCreateWhitelistedAddressRequest.

- `address` (string, required) — A blockchain address in canonical format.
- `label` (string, required) — A label to distinguish the address
- `blockchain` (string, required) — Symbol of the blockchain on which to whitelist an address
- `memo` (string, optional) — For blockchains which support `memo` tags, such as XLM or XRP, only whitelist for transactions using this value as `memo`.
- `exchangeAccountId` (string, optional) — The ID for the associated exchange account
- `customerId` (string, optional) — An optional string designating a user account. This field can't be used for filtering!
- `linkedInternalAddressIds` (list of string, optional) — A list of address IDs which are allowed to create requests targeting `address`
- `addressType` (string, optional) — Can be one of the following: `individual`, `exchange`, `baker`, `stakepool`, `contract`, `validator`, node
- `contractType` (string, optional) — Can be any of: `GENERIC`, `CMTA20`, `CMTA20-KYC`, `CMTA20-RULEENGINE`, `CMTAT`, `ERC20`, `DEFI`, `ERC2771-PROXY-ADMIN`, `TERC1155A`, `GSN_FORWARDER`, `OPEN_ZEPPELIN_FORWARDER`, `TAURUS_CONTRACT_CREATOR`, `SMARTPY-FA2`, `SMARTPY-FA12`, `ASA`, `FIGMENT_STAKING`
- `linkedWalletIds` (list of string, optional) — A list of wallet IDs which are allowed to create requests targeting `address`
- `network` (string, optional) — Name of the blockchain network, eg. `mainnet`, `testnet`, or `sepolia`
- `visibilityGroupID` (string, optional) — External ID of a restricted visibility group
- `currency` (string, optional) — **Deprecated:** use the blockchain parameter instead

## Response

### 200

A successful response.

- `result` (tgvalidatordIDResult, optional)

## Errors

### 400 Bad Request Error

Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

- `any`

### 401 Unauthorized Error

Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

- `any`

### 403 Forbidden Error

Forbidden: indicates that the server understands the request but refuses to authorize it

- `any`

### 404 Not Found Error

Not Found: indicates that the server cannot find the requested resource

- `any`

### 500 Internal Server Error

Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

- `any`

### 503 Service Unavailable Error

Service Unavailable: indicates that the server is not ready to handle the request.

- `any`

## Types

### tgvalidatordIDResult

- `id` (string, optional)

## Examples

**Request**

```json
{
  "address": "0x39c4622ac9704dfea991e9c26abcf9bde3c095ac",
  "label": "Address ABC",
  "blockchain": "ETH",
  "customerId": "customerABC",
  "addressType": "individual"
}
```

**Response**

```json
{
  "result": {
    "id": "1322"
  }
}
```

**SDK Code**

```python
import requests

url = "https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses"

payload = {
    "address": "0x39c4622ac9704dfea991e9c26abcf9bde3c095ac",
    "label": "Address ABC",
    "blockchain": "ETH",
    "customerId": "customerABC",
    "addressType": "individual"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"address":"0x39c4622ac9704dfea991e9c26abcf9bde3c095ac","label":"Address ABC","blockchain":"ETH","customerId":"customerABC","addressType":"individual"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses"

	payload := strings.NewReader("{\n  \"address\": \"0x39c4622ac9704dfea991e9c26abcf9bde3c095ac\",\n  \"label\": \"Address ABC\",\n  \"blockchain\": \"ETH\",\n  \"customerId\": \"customerABC\",\n  \"addressType\": \"individual\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"0x39c4622ac9704dfea991e9c26abcf9bde3c095ac\",\n  \"label\": \"Address ABC\",\n  \"blockchain\": \"ETH\",\n  \"customerId\": \"customerABC\",\n  \"addressType\": \"individual\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"0x39c4622ac9704dfea991e9c26abcf9bde3c095ac\",\n  \"label\": \"Address ABC\",\n  \"blockchain\": \"ETH\",\n  \"customerId\": \"customerABC\",\n  \"addressType\": \"individual\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses', [
  'body' => '{
  "address": "0x39c4622ac9704dfea991e9c26abcf9bde3c095ac",
  "label": "Address ABC",
  "blockchain": "ETH",
  "customerId": "customerABC",
  "addressType": "individual"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"address\": \"0x39c4622ac9704dfea991e9c26abcf9bde3c095ac\",\n  \"label\": \"Address ABC\",\n  \"blockchain\": \"ETH\",\n  \"customerId\": \"customerABC\",\n  \"addressType\": \"individual\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "address": "0x39c4622ac9704dfea991e9c26abcf9bde3c095ac",
  "label": "Address ABC",
  "blockchain": "ETH",
  "customerId": "customerABC",
  "addressType": "individual"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```