REST
POST
/api/v1/addresses/whitelist/paramsWhitelist Address With Params
Sends a request for the whitelisting of a new address with parameters.
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
| 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 addressasset*:string
// The asset code (e.g., BTC, USD)address*:string
// The address to be whitelistedaddressParams*:object
id:string
// ID informationhostedby:string
// Hosted by informationnetwork*:string
// The network of the asset (e.g., Bitcoin, Ethereum)Example
{
"name": "My Wallet",
"asset": "BTC",
"address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"addressParams": {
"id": "id-info",
"hostedby": "hostedby-info"
},
"network": "Bitcoin"
}Response
Success Response Schema
Address created successfully
| Field | Type | Description |
|---|---|---|
httpStatusCode | number | HTTP status code of the response |
addressId | string | Unique identifier for the whitelisted address |
endUserId | string | End user ID associated with the whitelisted address |
message | string | Response message indicating the result of the request |
Responses
Address created 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/params