Whitelist Address

Sends a request for the whitelisting of a new address.

Auth:Bearer <api_key>

Tags:Addresses

Request

cURL

curl -X POST https://publicapi.sandbox.hercle.financial/api/v1/addresses/whitelist \
  -H "Authorization: Bearer eyJhb..." \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication
Content-Type	string	Yes	Content type of the request body

Request Body

Schema

object

name*:string

// A name for the address

asset*:string

// The asset code (e.g., BTC, USD)

address*:string

// The address to be whitelisted

network*:string

// The network of the asset (e.g., Bitcoin, Ethereum)

Example

{
  "name": "My Wallet",
  "asset": "BTC",
  "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
  "network": "Bitcoin"
}

Response

Success Response Schema

Address whitelisting request submitted successfully

Field	Type	Description
`httpStatusCode`	number	Status code of the registration: 201 (created). The HTTP status of the response is 200
`addressId`	string	Unique identifier for the whitelisted address
`message`	string	Always an empty string on success
`network`	string	Network of the whitelisted address, as sent in the request

Responses

Address whitelisting request submitted successfully

200 application/json

{
  "httpStatusCode": 201,
  "addressId": "123e4567-e89b-12d3-a456-426614174000",
  "message": "",
  "network": "Bitcoin"
}

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Request Body

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/addresses/whitelist