Get Whitelisted Addresses

Retrieve a list of whitelisted addresses associated with the account, both fiat and crypto.

Auth:Bearer <api_key>

Tags:Addresses

Request

cURL

curl -G https://publicapi.sandbox.hercle.financial/api/v1/addresses/whitelisted \
  -H "Authorization: Bearer eyJhb..." \

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

Success Response Schema

A list of whitelisted addresses that are pending (0) or approved (2). Refused and deleted addresses are not returned.

Field	Type	Description
`id`	string	Unique identifier for the address
`name`	string	User-defined name for the address
`userId`	string	ID of the user who owns the address
`asset`	string	Asset code (e.g., BTC, ETH, USD)
`address`	string	The whitelisted address
`addressParams`	object	Additional address parameters, as key-value strings. Which keys are present depends on the asset and network; {} when there are none.
`addressParams.hostedby`	string	Crypto: wallet control, "individual" or "vasp"
`addressParams.tag`	string	Crypto: destination tag (e.g. XRP)
`addressParams.sortcode`	string	GBP (Faster Payments): sort code
`network`	string	Network name (e.g., Bitcoin, Ethereum)
`status`	number	Current status of the address `0`→ Pending `2`→ Approved
`comment`	string	Comment or note about the address
`auditBy`	string	The auditor who reviewed the address
`auditDate`	string	ISO 8601 UTC timestamp of the audit. If the address was never audited, this is the time the server loaded the address list, not an audit time
`enabled`	boolean	Whether the address is currently enabled for use
`deleted`	boolean	Always false: deleted addresses are not returned
`creationDate`	string	ISO 8601 timestamp of when the address was created
`fiatRepublicPayeeId`	string \| null	ID of the payee registered for this address at FiatRepublic; null if none
`openPaydBankBeneficiaryId`	string \| null	ID of the bank beneficiary registered for this address at OpenPayd; null if none

Responses

A list of whitelisted addresses that are pending (0) or approved (2). Refused and deleted addresses are not returned.

200 application/json

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "My Whitelisted Address",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "asset": "BTC",
    "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "addressParams": {
      "hostedby": "vasp"
    },
    "network": "Bitcoin",
    "status": 2,
    "comment": "Primary BTC wallet",
    "auditBy": "admin_user",
    "auditDate": "2025-10-01T12:34:56.000Z",
    "enabled": true,
    "deleted": false,
    "creationDate": "2025-09-15T08:00:00.000Z",
    "fiatRepublicPayeeId": null,
    "openPaydBankBeneficiaryId": null
  },
  {
    "id": "987e6543-e21b-12d3-a456-426614174001",
    "name": "My Second Address",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "asset": "ETH",
    "address": "0x32Be343B94f860124dC4fEe278FDCBD38C102D88",
    "addressParams": {},
    "network": "Ethereum",
    "status": 0,
    "comment": "Secondary ETH wallet",
    "auditBy": "admin_user",
    "auditDate": "2025-10-02T09:15:30.000Z",
    "enabled": false,
    "deleted": false,
    "creationDate": "2025-09-20T10:30:00.000Z",
    "fiatRepublicPayeeId": null,
    "openPaydBankBeneficiaryId": null
  }
]

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Request URL

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