> For the complete documentation index, see [llms.txt](https://dev.guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.guardian.hedera.com/guardian/tokens/retirement-contract/retirement-apis.md).

# 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](/guardian/tokens/retirement-contract/retirement-apis/returns-all-contracts.md)
* [Creating New Contract](/guardian/tokens/retirement-contract/retirement-apis/creating-new-contract.md)
* [Importing New Contract](/guardian/tokens/retirement-contract/retirement-apis/importing-new-contract.md)
* [Removing Contract](/guardian/tokens/retirement-contract/retirement-apis/removing-contract.md)
* [Get Contract Permissions](/guardian/tokens/retirement-contract/retirement-apis/get-contract-permissions.md)
* [Adding Retire Admin](/guardian/tokens/retirement-contract/retirement-apis/adding-retire-admin.md)
* [Removing Retire Admin](/guardian/tokens/retirement-contract/retirement-apis/removing-retire-admin.md)
* [Returning List of All Retire Pools](/guardian/tokens/retirement-contract/retirement-apis/returning-list-of-all-retire-pools.md)
* [Setting Retire Pools](/guardian/tokens/retirement-contract/retirement-apis/setting-retire-pools.md)
* [Deleting Retire Pools](/guardian/tokens/retirement-contract/retirement-apis/deleting-retire-pools.md)
* [Unsetting Retire Pool](/guardian/tokens/retirement-contract/retirement-apis/unsetting-retire-pool.md)
* [Syncing Retire Pools](/guardian/tokens/retirement-contract/retirement-apis/syncing-retire-pools.md)
* [Returning List of All Retire Requests](/guardian/tokens/retirement-contract/retirement-apis/returning-list-of-all-retire-requests.md)
* [Deleting Retire Requests](/guardian/tokens/retirement-contract/retirement-apis/deleting-retire-requests.md)
* [Approving Retire Request](/guardian/tokens/retirement-contract/retirement-apis/approving-retire-request.md)
* [Cancelling Retire Request](/guardian/tokens/retirement-contract/retirement-apis/cancelling-retire-request.md)
* [Retiring Tokens](/guardian/tokens/retirement-contract/retirement-apis/retiring-tokens.md)
* [Returning All Retired VCs](/guardian/tokens/retirement-contract/retirement-apis/returning-all-retired-vcs.md)
* [Returns a List of All Wipe Requests](/guardian/tokens/retirement-contract/retirement-apis/returns-a-list-of-all-wipe-requests.md)
* [Approving Wipe Requests](/guardian/tokens/retirement-contract/retirement-apis/approving-wipe-requests.md)
* [Clearing Wipe Requests](/guardian/tokens/retirement-contract/retirement-apis/clearing-wipe-requests.md)
* [Rejecting Wipe Requests](/guardian/tokens/retirement-contract/retirement-apis/rejecting-wipe-requests.md)
* [Adding Wipe Admin](/guardian/tokens/retirement-contract/retirement-apis/adding-wipe-admin.md)
* [Removing Wipe Admin](/guardian/tokens/retirement-contract/retirement-apis/removing-wipe-admin.md)
* [Adding Wipe Manager](/guardian/tokens/retirement-contract/retirement-apis/adding-wipe-manager.md)
* [Removing Wipe Manager](/guardian/tokens/retirement-contract/retirement-apis/removing-wipe-manager.md)
* [Adding Wipe Wiper](/guardian/tokens/retirement-contract/retirement-apis/adding-wipe-wiper.md)
* [Removing Wipe Wiper](/guardian/tokens/retirement-contract/retirement-apis/removing-wipe-wiper.md)
* [Enabling Wipe Requests](/guardian/tokens/retirement-contract/retirement-apis/enabling-wipe-requests.md)
* [Disabling Wipe Requests](/guardian/tokens/retirement-contract/retirement-apis/disabling-wipe-requests.md)
* [Adding Wipe for Specific Token](/guardian/tokens/retirement-contract/retirement-apis/adding-wipe-for-specific-token.md)
* [Deleting Wipe Request for Hedera Account](/guardian/tokens/retirement-contract/retirement-apis/deleting-wipe-request-for-hedera-account.md)
* [Get Retirement VCs from Indexer](/guardian/tokens/retirement-contract/retirement-apis/get-retirement-vcs-from-indexer.md)
* [Remove Wipe Request for Specific Token](/guardian/tokens/retirement-contract/retirement-apis/remove-wipe-request-for-specific-token.md)
* [Unsetting Retire Request](/guardian/tokens/retirement-contract/retirement-apis/unsetting-retire-request.md)