Retirement APIs

Endpoints for creating and managing Guardian retirement contracts, retire pools, wipe requests, and associated administrators.

Authentication: Bearer token required (Authorization: Bearer <token>)

---

Method	Endpoint	Description	Auth Required
GET	/api/v1/contracts	Returns all retirement contracts	Yes
POST	/api/v1/contracts	Creates a new retirement contract	Yes
POST	/api/v1/contracts/import	Imports an existing retirement contract	Yes
DELETE	/api/v1/contracts/{contractId}	Removes a retirement contract	Yes
GET	/api/v1/contracts/{contractId}/permissions	Returns permissions for the contract	Yes
POST	/api/v1/contracts/retire/{contractId}/admin/{hederaId}	Adds a retire administrator	Yes
DELETE	/api/v1/contracts/retire/{contractId}/admin/{hederaId}	Removes a retire administrator	Yes
GET	/api/v1/contracts/retire/pools	Returns all retire pools	Yes
POST	/api/v1/contracts/retire/pools	Sets retire pools	Yes
DELETE	/api/v1/contracts/retire/pools	Deletes retire pools	Yes
DELETE	/api/v1/contracts/retire/pools/{poolId}	Unsets a retire pool	Yes
POST	/api/v1/contracts/retire/pools/sync	Synchronizes retire pools	Yes
GET	/api/v1/contracts/retire/requests	Returns all retire requests	Yes
DELETE	/api/v1/contracts/retire/requests	Deletes all retire requests	Yes
POST	/api/v1/contracts/retire/requests/{requestId}/approve	Approves a retire request	Yes
DELETE	/api/v1/contracts/retire/requests/{requestId}	Cancels a retire request	Yes
POST	/api/v1/contracts/retire	Retires tokens	Yes
GET	/api/v1/contracts/retire	Returns all retired VCs	Yes
GET	/api/v1/contracts/wipe/requests	Returns all wipe requests	Yes
POST	/api/v1/contracts/wipe/requests/{requestId}/approve	Approves wipe requests	Yes
DELETE	/api/v1/contracts/wipe/requests	Clears wipe requests	Yes
DELETE	/api/v1/contracts/wipe/requests/{requestId}	Rejects wipe requests	Yes
POST	/api/v1/contracts/{contractId}/wipe/admin/{hederaId}	Adds a wipe administrator	Yes
DELETE	/api/v1/contracts/{contractId}/wipe/admin/{hederaId}	Removes a wipe administrator	Yes
POST	/api/v1/contracts/{contractId}/wipe/manager/{hederaId}	Adds a wipe manager	Yes
DELETE	/api/v1/contracts/{contractId}/wipe/manager/{hederaId}	Removes a wipe manager	Yes
POST	/api/v1/contracts/{contractId}/wipe/wiper/{hederaId}	Adds a wipe wiper	Yes
DELETE	/api/v1/contracts/{contractId}/wipe/wiper/{hederaId}	Removes a wipe wiper	Yes
POST	/api/v1/contracts/{contractId}/wipe/requests/enable	Enables wipe requests	Yes
POST	/api/v1/contracts/{contractId}/wipe/requests/disable	Disables wipe requests	Yes

Endpoints

• Returns All Contracts

• Creating New Contract

• Importing New Contract

• Removing Contract

• Get Contract Permissions

• Adding Retire Admin

• Removing Retire Admin

• Returning List of All Retire Pools

• Setting Retire Pools

• Deleting Retire Pools

• Unsetting Retire Pool

• Syncing Retire Pools

• Returning List of All Retire Requests

• Deleting Retire Requests

• Approving Retire Request

• Cancelling Retire Request

• Retiring Tokens

• Returning All Retired VCs

• Returns a List of All Wipe Requests

• Approving Wipe Requests

• Clearing Wipe Requests

• Rejecting Wipe Requests

• Adding Wipe Admin

• Removing Wipe Admin

• Adding Wipe Manager

• Removing Wipe Manager

• Adding Wipe Wiper

• Removing Wipe Wiper

• Enabling Wipe Requests

• Disabling Wipe Requests

• Adding Wipe for Specific Token

• Deleting Wipe Request for Hedera Account

• Get Retirement VCs from Indexer

• Remove Wipe Request for Specific Token

• Unsetting Retire Request