REST
DELETE
/api/v1/addresses/whitelistRemove Whitelisted Address
Permanently delete an address. This cannot be undone.
Auth:Bearer <api_key>
Tags:Addresses
Request
cURL
curl -X DELETE https://publicapi.sandbox.hercle.financial/api/v1/addresses/whitelist \
-H "Authorization: Bearer eyJhb..." \
-H "Content-Type: application/json" \
-d '{"id": "addr_1234567890"}'Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer token for authentication |
Request Body
Schema
| Field | Type | Description | Required |
|---|---|---|---|
addressId | string | The ID of the address to be deleted | Yes |
Example
{
"addressId": "addr_1234567890"
}Response
Success Response Schema
Address successfully deleted
| Field | Type | Description |
|---|---|---|
httpStatusCode | number | HTTP status code indicating the result of the operation |
addressId | string | Unique identifier for the deleted address |
endUserId | string | End user ID associated with the deleted address |
message | string | Response message indicating the result of the deletion |
Responses
Address successfully deleted
200 application/json
{
"httpStatusCode": 200,
"addressId": "123e4567-e89b-12d3-a456-426614174000",
"endUserId": "enduser-123",
"message": ""
}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