Hercle
REST
POST/api/v1/addresses/whitelist/params

Whitelist Address With Params

Sends a request for the whitelisting of a new address with parameters. The required address parameters vary by asset and network (crypto vs. EUR/GBP/USD fiat rails) — see addressParams below.

Auth:Bearer <api_key>
Tags:Addresses

Request

cURL
curl -X POST https://publicapi.sandbox.hercle.financial/api/v1/addresses/whitelist/params \
  -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
addressParams*:array
// Additional parameters for the address, as a list of { id, value } pairs. Which keys apply depends on the asset and network: ** Crypto: ** • hostedby: Wallet control — "individual" (unhosted) or "vasp" • tag: Destination tag (XRP) • memo: Memo (ALGO, XLM) ** EUR - Sepa: ** • bic (required): Bank Identifier Code (SWIFT code) ** GBP - Faster Payments: ** • sortcode (required): Sort code of the bank ** USD - INTERNATIONAL_WIRE: ** • accountnumber (required): Bank account number (or IBAN) • bic (required): Bank Identifier Code (SWIFT code) • aba (required): American Banking Association routing number • bankname (required): Name of the bank • bankaddressline1 (required): First line of the bank's address • bankaddresscity (required): Bank's city • bankaddresspostalcode (required): Bank's postal code • bankcountry (required): Bank's country code (ISO alpha-2) • state: Bank's state/region (required for US/CA/AU/CN/MX/MY) ** USD - DOMESTIC_WIRE: ** • accountnumber (required): Bank account number • bic (required): Bank Identifier Code (SWIFT code) • bankname (required): Name of the bank • wire (required): Wire routing number • bankcountry (required): Bank's country code (ISO alpha-2) ** USD - ACH / ACH_SAME_DAY: ** • accountnumber (required): Bank account number • aba (required): ACH routing number • accounttype (required): Account type (CHECKING or SAVINGS) ** Any: ** • leicode: Legal Entity Identifier (optional)
[item]:object
network*:string
// The network for the address. Available options by asset: ** Crypto: ** the chain name (e.g., Bitcoin, Ethereum) ** EUR: ** Sepa ** GBP: ** Faster Payments ** USD: ** INTERNATIONAL_WIRE, DOMESTIC_WIRE, ACH, ACH_SAME_DAY

Example

{
  "name": "My Wallet",
  "asset": "BTC",
  "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
  "addressParams": [
    {
      "id": "hostedby",
      "value": "vasp"
    }
  ],
  "network": "Bitcoin"
}

Response

Success Response Schema

FieldTypeDescription
httpStatusCodenumberAlways 201 on success. This is not the HTTP status of the response, which is 200
addressIdstringUnique identifier for the whitelisted address
messagestringAlways an empty string on success
networkstringNetwork the address was registered on, as sent in the request

Responses

Address created 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

Get your API key from Hercle Sandbox

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