Hercle
REST
POST/api/v1/addresses/whitelist

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

NameTypeRequiredDescription
AuthorizationstringYesBearer token for authentication
Content-TypestringYesContent 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

FieldTypeDescription
httpStatusCodenumberHTTP status code of the response
addressIdstringUnique identifier for the whitelisted address
endUserIdstringEnd user ID associated with the whitelisted address
messagestringResponse message indicating the result of the request

Responses

Address whitelisting request submitted successfully

201 application/json
{
  "httpStatusCode": 201,
  "addressId": "123e4567-e89b-12d3-a456-426614174000",
  "endUserId": "enduser-123",
  "message": "Address whitelisting request submitted successfully"
}

API Tester

Test this endpoint directly against the sandbox environment

Get your API key from Hercle Sandbox

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