> 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/static-spec-test/hedera/contracts.md).

# Contracts

## Return a list of all contracts.

> Returns all contracts.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ContractDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time","description":"Record creation time (from persistence layer)."},"updateDate":{"type":"string","format":"date-time","description":"Record last update time (from persistence layer)."},"id":{"type":"string"},"contractId":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"permissions":{"type":"number","description":"Bitmask of caller roles (values are additive): 1 = Owner, 2 = Admin, 4 = Manager (WIPE only), 8 = Wiper (WIPE v1.0.0 only). E.g. 3 = Owner+Admin (RETIRE), 7 = Owner+Admin+Manager (WIPE)."},"topicId":{"type":"string"},"type":{"type":"string","enum":["WIPE","RETIRE"]},"syncPoolsDate":{"format":"date-time","type":"string","description":"Last sync of retire pools (may be absent)."},"lastSyncEventTimeStamp":{"type":"string","description":"Hedera consensus timestamp string from last processed contract event."},"syncDisabled":{"type":"boolean","description":"When true, automatic sync is disabled for this contract."},"version":{"type":"string","description":"Deployed contract ABI / behavior version."},"wipeContractIds":{"description":"Legacy: linked WIPE contract Hedera ids (contract-level wiper). Often empty for `version` 1.0.1+; see `wipeTokenIds` instead.","type":"array","items":{"type":"string"}},"wipeTokenIds":{"description":"Token-level wiper allowlist (Hedera token ids). Typical for RETIRE contracts with `version` 1.0.1+; usually empty for WIPE contracts.","type":"array","items":{"type":"string"}}},"required":["createDate","updateDate","id","contractId","owner","permissions","topicId","type"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts":{"get":{"description":"Returns all contracts.","operationId":"ContractsApi_getContracts","parameters":[{"name":"type","required":true,"in":"query","description":"Contract type","schema":{"enum":["WIPE","RETIRE"],"type":"string"}},{"name":"pageIndex","required":false,"in":"query","description":"The number of pages to skip before starting to collect the result set","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","description":"The numbers of items to return","schema":{"type":"number"}}],"responses":{"200":{"description":"Contracts.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContractDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of all contracts.","tags":["contracts"]}}}}
```

## Create contract.

> Create smart-contract. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ContractConfigDTO":{"type":"object","properties":{"type":{"type":"string","enum":["WIPE","RETIRE"]},"description":{"type":"string"}},"required":["type","description"]},"ContractDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time","description":"Record creation time (from persistence layer)."},"updateDate":{"type":"string","format":"date-time","description":"Record last update time (from persistence layer)."},"id":{"type":"string"},"contractId":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"permissions":{"type":"number","description":"Bitmask of caller roles (values are additive): 1 = Owner, 2 = Admin, 4 = Manager (WIPE only), 8 = Wiper (WIPE v1.0.0 only). E.g. 3 = Owner+Admin (RETIRE), 7 = Owner+Admin+Manager (WIPE)."},"topicId":{"type":"string"},"type":{"type":"string","enum":["WIPE","RETIRE"]},"syncPoolsDate":{"format":"date-time","type":"string","description":"Last sync of retire pools (may be absent)."},"lastSyncEventTimeStamp":{"type":"string","description":"Hedera consensus timestamp string from last processed contract event."},"syncDisabled":{"type":"boolean","description":"When true, automatic sync is disabled for this contract."},"version":{"type":"string","description":"Deployed contract ABI / behavior version."},"wipeContractIds":{"description":"Legacy: linked WIPE contract Hedera ids (contract-level wiper). Often empty for `version` 1.0.1+; see `wipeTokenIds` instead.","type":"array","items":{"type":"string"}},"wipeTokenIds":{"description":"Token-level wiper allowlist (Hedera token ids). Typical for RETIRE contracts with `version` 1.0.1+; usually empty for WIPE contracts.","type":"array","items":{"type":"string"}}},"required":["createDate","updateDate","id","contractId","owner","permissions","topicId","type"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts":{"post":{"description":"Create smart-contract. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_createContractV2_2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractConfigDTO"}}}},"responses":{"201":{"description":"Created contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Create contract.","tags":["contracts"]}}}}
```

## Import contract.

> Import smart-contract. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ImportContractDTO":{"type":"object","properties":{"contractId":{"type":"string","description":"Hedera contract identifier"},"description":{"type":"string","description":"Contract description"}},"required":["contractId"]},"ContractDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time","description":"Record creation time (from persistence layer)."},"updateDate":{"type":"string","format":"date-time","description":"Record last update time (from persistence layer)."},"id":{"type":"string"},"contractId":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"permissions":{"type":"number","description":"Bitmask of caller roles (values are additive): 1 = Owner, 2 = Admin, 4 = Manager (WIPE only), 8 = Wiper (WIPE v1.0.0 only). E.g. 3 = Owner+Admin (RETIRE), 7 = Owner+Admin+Manager (WIPE)."},"topicId":{"type":"string"},"type":{"type":"string","enum":["WIPE","RETIRE"]},"syncPoolsDate":{"format":"date-time","type":"string","description":"Last sync of retire pools (may be absent)."},"lastSyncEventTimeStamp":{"type":"string","description":"Hedera consensus timestamp string from last processed contract event."},"syncDisabled":{"type":"boolean","description":"When true, automatic sync is disabled for this contract."},"version":{"type":"string","description":"Deployed contract ABI / behavior version."},"wipeContractIds":{"description":"Legacy: linked WIPE contract Hedera ids (contract-level wiper). Often empty for `version` 1.0.1+; see `wipeTokenIds` instead.","type":"array","items":{"type":"string"}},"wipeTokenIds":{"description":"Token-level wiper allowlist (Hedera token ids). Typical for RETIRE contracts with `version` 1.0.1+; usually empty for WIPE contracts.","type":"array","items":{"type":"string"}}},"required":["createDate","updateDate","id","contractId","owner","permissions","topicId","type"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/import":{"post":{"description":"Import smart-contract. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_importContract","parameters":[],"requestBody":{"required":true,"description":"Contract import configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportContractDTO"}}}},"responses":{"200":{"description":"Imported contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Import contract.","tags":["contracts"]}}}}
```

## Get contract permissions.

> Get smart-contract permissions. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/{contractId}/permissions":{"get":{"description":"Get smart-contract permissions. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_contractPermissions","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Contract permissions.","content":{"application/json":{"schema":{"type":"number"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get contract permissions.","tags":["contracts"]}}}}
```

## Remove contract.

> Remove smart-contract. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/{contractId}":{"delete":{"description":"Remove smart-contract. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_removeContract","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Remove contract.","tags":["contracts"]}}}}
```

## Return a list of all wipe requests.

> Returns all wipe requests. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"WiperRequestDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time","description":"Record creation time."},"updateDate":{"type":"string","format":"date-time","description":"Record last update time."},"contractId":{"type":"string"},"user":{"type":"string","description":"Hedera account id of the requester."},"token":{"type":"string","description":"Hedera token id."},"id":{"type":"string"}},"required":["createDate","updateDate","contractId","user","id"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/requests":{"get":{"description":"Returns all wipe requests. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_getWipeRequests","parameters":[{"name":"contractId","required":true,"in":"query","description":"Contract identifier","schema":{"type":"string"}},{"name":"pageIndex","required":false,"in":"query","description":"The number of pages to skip before starting to collect the result set","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","description":"The numbers of items to return","schema":{"type":"number"}}],"responses":{"200":{"description":"Successful operation.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WiperRequestDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of all wipe requests.","tags":["contracts"]}}}}
```

## Enable wipe requests.

> Enable wipe contract requests. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/requests/enable":{"post":{"description":"Enable wipe contract requests. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_enableWipeRequests","parameters":[{"name":"contractId","required":true,"in":"path","description":"Wipe Contract Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Enable wipe requests.","tags":["contracts"]}}}}
```

## Disable wipe requests.

> Disable wipe contract requests. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/requests/disable":{"post":{"description":"Disable wipe contract requests. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_disableWipeRequests","parameters":[{"name":"contractId","required":true,"in":"path","description":"Wipe Contract Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Disable wipe requests.","tags":["contracts"]}}}}
```

## Approve wipe request.

> Approve wipe contract request. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/requests/{requestId}/approve":{"post":{"description":"Approve wipe contract request. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_approveWipeRequest","parameters":[{"name":"requestId","required":true,"in":"path","description":"Request identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Approve wipe request.","tags":["contracts"]}}}}
```

## Reject wipe request.

> Reject wipe contract request. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/requests/{requestId}/reject":{"delete":{"description":"Reject wipe contract request. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_rejectWipeRequest","parameters":[{"name":"requestId","required":true,"in":"path","description":"Request identifier","schema":{"type":"string"}},{"name":"ban","required":false,"in":"query","description":"Reject and ban","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Reject wipe request.","tags":["contracts"]}}}}
```

## Clear wipe requests.

> Clear wipe contract requests. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/requests":{"delete":{"description":"Clear wipe contract requests. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_clearWipeRequests","parameters":[{"name":"contractId","required":true,"in":"path","description":"Wipe Contract Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Clear wipe requests.","tags":["contracts"]}}}}
```

## Clear wipe requests for hedera account.

> Clear wipe contract requests for specific hedera account. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/requests/{hederaId}":{"delete":{"description":"Clear wipe contract requests for specific hedera account. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_clearWipeRequestsWithHederaId","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Clear wipe requests for hedera account.","tags":["contracts"]}}}}
```

## Add wipe admin.

> Add wipe contract admin. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/admin/{hederaId}":{"post":{"description":"Add wipe contract admin. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_wipeAddAdmin","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Add wipe admin.","tags":["contracts"]}}}}
```

## Remove wipe admin.

> Remove wipe contract admin. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/admin/{hederaId}":{"delete":{"description":"Remove wipe contract admin. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_wipeRemoveAdmin","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Remove wipe admin.","tags":["contracts"]}}}}
```

## Add wipe manager.

> Add wipe contract manager. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/manager/{hederaId}":{"post":{"description":"Add wipe contract manager. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_wipeAddManager","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Add wipe manager.","tags":["contracts"]}}}}
```

## Remove wipe manager.

> Remove wipe contract manager. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/manager/{hederaId}":{"delete":{"description":"Remove wipe contract manager. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_wipeRemoveManager","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Remove wipe manager.","tags":["contracts"]}}}}
```

## Add wipe wiper.

> Add wipe contract wiper. For Wipe contracts v1.0.0 only. For v1.0.1+ use the endpoint with tokenId. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/wiper/{hederaId}":{"post":{"description":"Add wipe contract wiper. For Wipe contracts v1.0.0 only. For v1.0.1+ use the endpoint with tokenId. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_wipeAddWiper","parameters":[{"name":"contractId","required":true,"in":"path","description":"Wipe Contract Identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Add wipe wiper.","tags":["contracts"]}}}}
```

## Remove wipe wiper.

> Remove wipe contract wiper. For Wipe contracts v1.0.0 only. For v1.0.1+ use the endpoint with tokenId. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/wiper/{hederaId}":{"delete":{"description":"Remove wipe contract wiper. For Wipe contracts v1.0.0 only. For v1.0.1+ use the endpoint with tokenId. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_wipeRemoveWiper","parameters":[{"name":"contractId","required":true,"in":"path","description":"Wipe Contract Identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Remove wipe wiper.","tags":["contracts"]}}}}
```

## Add wipe wiper for token.

> Add wipe contract wiper for specific token. For Wipe contracts v1.0.1+ only. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/wiper/{hederaId}/{tokenId}":{"post":{"description":"Add wipe contract wiper for specific token. For Wipe contracts v1.0.1+ only. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_wipeAddWiperWithToken","parameters":[{"name":"contractId","required":true,"in":"path","description":"Wipe Contract Identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}},{"name":"tokenId","required":true,"in":"path","description":"Token identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Add wipe wiper for token.","tags":["contracts"]}}}}
```

## Remove wipe wiper for token.

> Remove wipe contract wiper for specific token. For Wipe contracts v1.0.1+ only. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/wipe/{contractId}/wiper/{hederaId}/{tokenId}":{"delete":{"description":"Remove wipe contract wiper for specific token. For Wipe contracts v1.0.1+ only. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_wipeRemoveWiperWithToken","parameters":[{"name":"contractId","required":true,"in":"path","description":"Wipe Contract Identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}},{"name":"tokenId","required":true,"in":"path","description":"Token identifier. The token the wiper was allowed to wipe.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Remove wipe wiper for token.","tags":["contracts"]}}}}
```

## Sync retire pools.

> Sync retire contract pools. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/{contractId}/pools/sync":{"post":{"description":"Sync retire contract pools. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_retireSyncPools","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Sync date in ISO 8601 format. The timestamp when pools were synced.","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Sync retire pools.","tags":["contracts"]}}}}
```

## Return a list of all retire requests.

> Returns all retire requests.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RetireRequestDTO":{"type":"object","properties":{"id":{"type":"string"},"contractId":{"type":"string"},"tokens":{"type":"object","required":["token","count","serials","decimals","type","tokenSymbol"],"properties":{"token":{"type":"string"},"count":{"type":"number"},"serials":{"type":"array","items":{"type":"number"}},"decimals":{"type":"number"},"type":{"enum":["non-fungible","fungible"]},"tokenSymbol":{"type":"string"}}},"tokenIds":{"type":"array","items":{"type":"string"}},"user":{"type":"string"}},"required":["id","contractId","tokenIds","user"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/requests":{"get":{"description":"Returns all retire requests.","operationId":"ContractsApi_getRetireRequests","parameters":[{"name":"contractId","required":true,"in":"query","description":"Contract identifier","schema":{"type":"string"}},{"name":"pageIndex","required":false,"in":"query","description":"The number of pages to skip before starting to collect the result set","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","description":"The numbers of items to return","schema":{"type":"number"}}],"responses":{"200":{"description":"Successful operation.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RetireRequestDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of all retire requests.","tags":["contracts"]}}}}
```

## Return a list of all retire pools.

> Returns all retire pools.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RetirePoolDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time","description":"Record creation time."},"updateDate":{"type":"string","format":"date-time","description":"Record last update time."},"id":{"type":"string"},"contractId":{"type":"string"},"tokens":{"type":"object","required":["token","contract","count","decimals","type","tokenSymbol"],"properties":{"token":{"type":"string","description":"Hedera token id."},"contract":{"type":"string","description":"Wipe contract id."},"count":{"type":"number","description":"Token count in pool."},"decimals":{"type":"number","description":"Token decimals."},"type":{"type":"string","enum":["non-fungible","fungible"]},"tokenSymbol":{"type":"string","description":"Token symbol."}}},"tokenIds":{"description":"Token ids in pool.","type":"array","items":{"type":"string"}},"immediately":{"type":"boolean","description":"Retire immediately without approval."},"enabled":{"type":"boolean","description":"Pool is enabled."}},"required":["id","contractId","tokenIds","immediately","enabled"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/pools":{"get":{"description":"Returns all retire pools.","operationId":"ContractsApi_getRetirePools","parameters":[{"name":"contractId","required":true,"in":"query","description":"Contract identifier","schema":{"type":"string"}},{"name":"tokens","required":true,"in":"query","description":"Comma-separated token IDs. No spaces between tokens.","schema":{"type":"string"}},{"name":"pageIndex","required":false,"in":"query","description":"The number of pages to skip before starting to collect the result set","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","description":"The numbers of items to return","schema":{"type":"number"}}],"responses":{"200":{"description":"Successful operation.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RetirePoolDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of all retire pools.","tags":["contracts"]}}}}
```

## Clear retire requests.

> Clear retire contract requests. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/{contractId}/requests":{"delete":{"description":"Clear retire contract requests. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_clearRetireRequests","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Clear retire requests.","tags":["contracts"]}}}}
```

## Set retire pool.

> Set retire contract pool. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RetirePoolTokenDTO":{"type":"object","properties":{"token":{"type":"string"},"count":{"type":"number"}},"required":["token","count"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/{contractId}/pools":{"post":{"description":"Set retire contract pool. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_setRetirePool","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetirePoolTokenDTO"}}}},"responses":{"200":{"description":"Successful operation."},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Set retire pool.","tags":["contracts"]}}}}
```

## Clear retire pools.

> Clear retire contract pools. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/{contractId}/pools":{"delete":{"description":"Clear retire contract pools. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_clearRetirePools","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Clear retire pools.","tags":["contracts"]}}}}
```

## Unset retire pool.

> Unset retire contract pool. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/pools/{poolId}":{"delete":{"description":"Unset retire contract pool. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_unsetRetirePool","parameters":[{"name":"poolId","required":true,"in":"path","description":"Pool Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Unset retire pool.","tags":["contracts"]}}}}
```

## Unset retire request.

> Unset retire contract request. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/requests/{requestId}":{"delete":{"description":"Unset retire contract request. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_unsetRetireRequest","parameters":[{"name":"requestId","required":true,"in":"path","description":"Request Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Unset retire request.","tags":["contracts"]}}}}
```

## Retire tokens.

> Retire tokens.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RetireRequestTokenFTDTO":{"type":"object","properties":{"token":{"type":"string"},"count":{"type":"number"},"serials":{"description":"Use empty array for FT retire request.","type":"array","items":{"type":"number"}}},"required":["token","count","serials"]},"RetireRequestTokenNFTDTO":{"type":"object","properties":{"token":{"type":"string"},"count":{"type":"number","description":"Required; use `0` for NFT retire request."},"serials":{"description":"NFT serial numbers to retire.","type":"array","items":{"type":"number"}}},"required":["token","count","serials"]},"BadRequestErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/pools/{poolId}/retire":{"post":{"description":"Retire tokens.","operationId":"ContractsApi_retire","parameters":[{"name":"poolId","required":true,"in":"path","description":"Pool Identifier","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/RetireRequestTokenFTDTO"},{"$ref":"#/components/schemas/RetireRequestTokenNFTDTO"}]}}}}},"responses":{"200":{"description":"Successful operation. Returns retire pool `immediately` flag: `true` — tokens are retired right away; `false` — retirement requires approval.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErrorDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Retire tokens.","tags":["contracts"]}}}}
```

## Approve retire request.

> Approve retire contract request. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/requests/{requestId}/approve":{"post":{"description":"Approve retire contract request. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_approveRetire","parameters":[{"name":"requestId","required":true,"in":"path","description":"Request identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Approve retire request.","tags":["contracts"]}}}}
```

## Cancel retire request.

> Cancel retire contract request. Intended for regular users (not Standard Registry) to cancel their own retire request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/requests/{requestId}/cancel":{"delete":{"description":"Cancel retire contract request. Intended for regular users (not Standard Registry) to cancel their own retire request.","operationId":"ContractsApi_cancelRetireRequest","parameters":[{"name":"requestId","required":true,"in":"path","description":"Request identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Cancel retire request.","tags":["contracts"]}}}}
```

## Add retire admin.

> Add retire contract admin. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/{contractId}/admin/{hederaId}":{"post":{"description":"Add retire contract admin. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_retireAddAdmin","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Add retire admin.","tags":["contracts"]}}}}
```

## Remove retire admin.

> Remove retire contract admin. Only users with the Standard Registry role are allowed to make the request.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire/{contractId}/admin/{hederaId}":{"delete":{"description":"Remove retire contract admin. Only users with the Standard Registry role are allowed to make the request.","operationId":"ContractsApi_retireRemoveAdmin","parameters":[{"name":"contractId","required":true,"in":"path","description":"Contract identifier","schema":{"type":"string"}},{"name":"hederaId","required":true,"in":"path","description":"Hedera account identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Remove retire admin.","tags":["contracts"]}}}}
```

## Return a list of all retire vcs.

> Returns all retire vcs.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RetireVcDocumentDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time"},"updateDate":{"type":"string","format":"date-time"},"hash":{"type":"string"},"hederaStatus":{"type":"string","description":"Hedera document status"},"signature":{"type":"number"},"type":{"type":"string"},"option":{"type":"object"},"owner":{"type":"string"},"document":{"description":"VerifiableCredential with credentialSubject (user, contractId, tokens)","allOf":[{"$ref":"#/components/schemas/RetireVcDocumentBodyDTO"}]},"documentFileId":{"type":"string"},"documentFields":{"type":"array","items":{"type":"string"}},"tableFileIds":{"type":"array","items":{"type":"string"}},"id":{"type":"string"}},"required":["createDate","updateDate","hash","hederaStatus","signature","type","option","owner","document","documentFileId","documentFields","tableFileIds","id"]},"RetireVcDocumentBodyDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"issuer":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"description":"Credential subjects","type":"array","items":{"$ref":"#/components/schemas/RetireCredentialSubjectDTO"}},"proof":{"$ref":"#/components/schemas/RetireVcProofDTO"}},"required":["id","type","issuer","issuanceDate","credentialSubject","proof"]},"RetireCredentialSubjectDTO":{"type":"object","properties":{"id":{"type":"string","description":"Subject DID"},"user":{"type":"string","description":"User Hedera account id"},"contractId":{"type":"string","description":"Retire contract id"},"tokens":{"description":"Retired tokens","type":"array","items":{"$ref":"#/components/schemas/RetireVcTokenDTO"}},"type":{"type":"string"}},"required":["id","user","contractId","tokens","type"]},"RetireVcTokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token id"},"count":{"type":"number","description":"For FT: amount. For NFT: 0"},"serials":{"description":"For NFT: serial numbers. For FT: empty","type":"array","items":{"type":"number"}}},"required":["tokenId","count","serials"]},"RetireVcProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retire":{"get":{"description":"Returns all retire vcs.","operationId":"ContractsApi_getRetireVCs","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"The number of pages to skip before starting to collect the result set","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","description":"The numbers of items to return","schema":{"type":"number"}}],"responses":{"200":{"description":"Successful operation.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RetireVcDocumentDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of all retire vcs.","tags":["contracts"]}}}}
```

## Return a list of all retire vcs from Indexer.

> Returns all retire vcs from Indexer.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"0.0.1"},"tags":[{"name":"contracts"}],"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RetireVcIndexerDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"lastUpdate":{"type":"number"},"topicId":{"type":"string","description":"Contract topic id"},"consensusTimestamp":{"type":"string"},"owner":{"type":"string"},"uuid":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"action":{"type":"string"},"lang":{"type":"string"},"responseType":{"type":"string"},"options":{"type":"object"},"analytics":{"type":"object"},"analyticsUpdate":{"type":"number"},"coordUpdate":{"type":"number"},"files":{"type":"array","items":{"type":"string"}},"documents":{"description":"Retire VC documents with credentialSubject (user, contractId, tokens)","type":"array","items":{"$ref":"#/components/schemas/RetireVcDocumentBodyDTO"}},"topics":{"type":"array","items":{"type":"string"}},"tokens":{"type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number"},"loaded":{"type":"boolean"}},"required":["id","lastUpdate","topicId","consensusTimestamp","owner","uuid","status","type","action","lang","responseType","options","analytics","analyticsUpdate","coordUpdate","files","documents","topics","tokens","sequenceNumber","loaded"]},"RetireVcDocumentBodyDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"issuer":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"description":"Credential subjects","type":"array","items":{"$ref":"#/components/schemas/RetireCredentialSubjectDTO"}},"proof":{"$ref":"#/components/schemas/RetireVcProofDTO"}},"required":["id","type","issuer","issuanceDate","credentialSubject","proof"]},"RetireCredentialSubjectDTO":{"type":"object","properties":{"id":{"type":"string","description":"Subject DID"},"user":{"type":"string","description":"User Hedera account id"},"contractId":{"type":"string","description":"Retire contract id"},"tokens":{"description":"Retired tokens","type":"array","items":{"$ref":"#/components/schemas/RetireVcTokenDTO"}},"type":{"type":"string"}},"required":["id","user","contractId","tokens","type"]},"RetireVcTokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token id"},"count":{"type":"number","description":"For FT: amount. For NFT: 0"},"serials":{"description":"For NFT: serial numbers. For FT: empty","type":"array","items":{"type":"number"}}},"required":["tokenId","count","serials"]},"RetireVcProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/contracts/retireIndexer":{"get":{"description":"Returns all retire vcs from Indexer.","operationId":"ContractsApi_getRetireVCsFromIndexer","parameters":[{"name":"contractTopicId","required":true,"in":"query","description":"The topic id of contract","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RetireVcIndexerDocumentDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of all retire vcs from Indexer.","tags":["contracts"]}}}}
```