Hercle
REST
DELETE/api/v1/addresses/whitelist

Remove 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

NameTypeRequiredDescription
AuthorizationstringYesBearer token for authentication

Request Body

Schema

FieldTypeDescriptionRequired
addressIdstringThe ID of the address to be deletedYes

Example

{
  "addressId": "addr_1234567890"
}

Response

Success Response Schema

FieldTypeDescription
httpStatusCodenumberHTTP status code indicating the result of the operation
addressIdstringUnique identifier for the deleted address
endUserIdstringEnd user ID associated with the deleted address
messagestringResponse 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