Contracts

Return a list of all contracts.

get

Returns all contracts.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typestring · enumRequired

Contract type

Possible values:

pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0

pageSizenumberRequired

The numbers of items to return

Example: 20

Responses

200

Contracts.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/contracts

HTTPcURLJavaScriptPython

GET /api/v1/contracts?type=WIPE&pageSize=20 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-20T08:24:09.121Z",
    "updateDate": "2026-03-20T09:08:01.905Z",
    "contractId": "0.0.8300131",
    "description": "Wipe contract description",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835",
    "permissions": 7,
    "topicId": "0.0.8300126",
    "type": "WIPE",
    "lastSyncEventTimeStamp": "1773997659.461000723",
    "wipeContractIds": [],
    "syncDisabled": false,
    "version": "1.0.1",
    "wipeTokenIds": [],
    "id": "69bd0429fdc2fd0bb2f9e95b"
  }
]

Create contract.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

typestring · enumRequiredExample: WIPEPossible values:

descriptionstringRequiredExample: Contract description

Responses

201

Created contract.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts

HTTPcURLJavaScriptPython

POST /api/v1/contracts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "type": "RETIRE",
  "description": "Retire contract description"
}

createContractBodyRetirecreateContractBodyWipe

{
  "createDate": "2026-03-20T09:30:28.129Z",
  "updateDate": "2026-03-20T09:30:28.129Z",
  "contractId": "0.0.8301737",
  "description": "Retire contract description",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835",
  "permissions": 3,
  "topicId": "0.0.8301715",
  "type": "RETIRE",
  "wipeContractIds": [],
  "syncDisabled": false,
  "version": "1.0.1",
  "wipeTokenIds": [],
  "id": "69bd13b4fdc2fd0bb2f9eccc"
}

Import contract.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

contractIdstringRequired

Hedera contract identifier

Example: 0.0.6046379

descriptionstringOptional

Contract description

Responses

200

Imported contract.

application/json

createDatestring · date-timeRequired

Record creation time (from persistence layer).

Example: 2026-03-03T17:25:53.312Z

updateDatestring · date-timeRequired

Record last update time (from persistence layer).

Example: 2026-03-03T17:25:53.312Z

idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5

contractIdstringRequiredExample: 0.0.6046379

descriptionstringOptionalExample: Contract description

ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

permissionsnumberRequired

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).

Example: 7

topicIdstringRequiredExample: 0.0.6046379

typestring · enumRequiredExample: WIPEPossible values:

syncPoolsDatestring · date-timeOptional

Last sync of retire pools (may be absent).

Example: 2026-03-03T17:25:53.312Z

lastSyncEventTimeStampstringOptional

Hedera consensus timestamp string from last processed contract event.

Example: 1773997659.461000723

syncDisabledbooleanOptional

When true, automatic sync is disabled for this contract.

Example: false

versionstringOptional

Deployed contract ABI / behavior version.

Example: 1.0.1

wipeContractIdsstring[]Optional

Legacy: linked WIPE contract Hedera ids (contract-level wiper). Often empty for version 1.0.1+; see wipeTokenIds instead.

wipeTokenIdsstring[]Optional

Token-level wiper allowlist (Hedera token ids). Typical for RETIRE contracts with version 1.0.1+; usually empty for WIPE contracts.

Example: ["0.0.8300593"]

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/import

HTTPcURLJavaScriptPython

POST /api/v1/contracts/import HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "contractId": "0.0.8301737",
  "description": "Imported contract"
}

{
  "createDate": "2026-03-20T09:30:28.129Z",
  "updateDate": "2026-03-20T09:30:28.129Z",
  "contractId": "0.0.8301737",
  "description": "Imported contract",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835",
  "permissions": 3,
  "topicId": "0.0.8301715",
  "type": "RETIRE",
  "lastSyncEventTimeStamp": "1773997659.461000723",
  "wipeContractIds": [],
  "syncDisabled": false,
  "version": "1.0.1",
  "wipeTokenIds": [],
  "id": "69bd13b4fdc2fd0bb2f9eccc"
}

Get contract permissions.

get

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract Identifier

Example: 652745597a7b53526de37c05

Responses

200

Contract permissions.

application/json

numberOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/contracts/{contractId}/permissions

HTTPcURLJavaScriptPython

GET /api/v1/contracts/{contractId}/permissions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

Remove contract.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract Identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/{contractId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/{contractId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Return a list of all wipe requests.

get

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

contractIdstringRequired

Contract identifier

Example: 0.0.1

pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0

pageSizenumberRequired

The numbers of items to return

Example: 20

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/contracts/wipe/requests

HTTPcURLJavaScriptPython

GET /api/v1/contracts/wipe/requests?contractId=0.0.1&pageSize=20 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-20T12:55:01.614Z",
    "updateDate": "2026-03-20T12:55:01.614Z",
    "contractId": "0.0.8300131",
    "user": "0.0.8300155",
    "token": "0.0.8305077",
    "id": "69bd43a55b864fe37954a8bb"
  }
]

Enable wipe requests.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Wipe Contract Identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/wipe/{contractId}/requests/enable

HTTPcURLJavaScriptPython

POST /api/v1/contracts/wipe/{contractId}/requests/enable HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Disable wipe requests.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Wipe Contract Identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/wipe/{contractId}/requests/disable

HTTPcURLJavaScriptPython

POST /api/v1/contracts/wipe/{contractId}/requests/disable HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Approve wipe request.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

requestIdstringRequired

Request identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/wipe/requests/{requestId}/approve

HTTPcURLJavaScriptPython

POST /api/v1/contracts/wipe/requests/{requestId}/approve HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Reject wipe request.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

requestIdstringRequired

Request identifier

Example: 652745597a7b53526de37c05

Query parameters

banbooleanOptional

Reject and ban

Example: true

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/wipe/requests/{requestId}/reject

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/wipe/requests/{requestId}/reject HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Clear wipe requests.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Wipe Contract Identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/wipe/{contractId}/requests

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/wipe/{contractId}/requests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Clear wipe requests for hedera account.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/wipe/{contractId}/requests/{hederaId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/wipe/{contractId}/requests/{hederaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Add wipe admin.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/wipe/{contractId}/admin/{hederaId}

HTTPcURLJavaScriptPython

POST /api/v1/contracts/wipe/{contractId}/admin/{hederaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Remove wipe admin.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/wipe/{contractId}/admin/{hederaId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/wipe/{contractId}/admin/{hederaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Add wipe manager.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/wipe/{contractId}/manager/{hederaId}

HTTPcURLJavaScriptPython

POST /api/v1/contracts/wipe/{contractId}/manager/{hederaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Remove wipe manager.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/wipe/{contractId}/manager/{hederaId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/wipe/{contractId}/manager/{hederaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Add wipe wiper.

post

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.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Wipe Contract Identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/wipe/{contractId}/wiper/{hederaId}

HTTPcURLJavaScriptPython

POST /api/v1/contracts/wipe/{contractId}/wiper/{hederaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Remove wipe wiper.

delete

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.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Wipe Contract Identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/wipe/{contractId}/wiper/{hederaId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/wipe/{contractId}/wiper/{hederaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Add wipe wiper for token.

post

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.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Wipe Contract Identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

tokenIdstringRequired

Token identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/wipe/{contractId}/wiper/{hederaId}/{tokenId}

HTTPcURLJavaScriptPython

POST /api/v1/contracts/wipe/{contractId}/wiper/{hederaId}/{tokenId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Remove wipe wiper for token.

delete

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.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Wipe Contract Identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

tokenIdstringRequired

Token identifier. The token the wiper was allowed to wipe.

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/wipe/{contractId}/wiper/{hederaId}/{tokenId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/wipe/{contractId}/wiper/{hederaId}/{tokenId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Sync retire pools.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

Responses

200

Sync date in ISO 8601 format. The timestamp when pools were synced.

application/json

stringOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/retire/{contractId}/pools/sync

HTTPcURLJavaScriptPython

POST /api/v1/contracts/retire/{contractId}/pools/sync HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

2026-03-20T16:45:30.000Z

Return a list of all retire requests.

get

Returns all retire requests.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

contractIdstringRequired

Contract identifier

Example: 0.0.1

pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0

pageSizenumberRequired

The numbers of items to return

Example: 20

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/contracts/retire/requests

HTTPcURLJavaScriptPython

GET /api/v1/contracts/retire/requests?contractId=0.0.1&pageSize=20 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "f3b2a9c1e4d5678901234567",
    "contractId": "f3b2a9c1e4d5678901234567",
    "tokenIds": [
      "eyJhbGciOi..."
    ],
    "user": "string"
  }
]

Return a list of all retire pools.

get

Returns all retire pools.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

contractIdstringRequired

Contract identifier

Example: 0.0.6046379

tokensstringRequired

Comma-separated token IDs. No spaces between tokens.

Example: 0.0.1,0.0.2,0.0.3

pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0

pageSizenumberRequired

The numbers of items to return

Example: 20

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/contracts/retire/pools

HTTPcURLJavaScriptPython

GET /api/v1/contracts/retire/pools?contractId=0.0.6046379&tokens=0.0.1%2C0.0.2%2C0.0.3&pageSize=20 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-20T17:58:51.312Z",
    "updateDate": "2026-03-20T18:00:01.342Z",
    "contractId": "0.0.8308132",
    "tokens": [
      {
        "token": "0.0.8308700",
        "count": 1,
        "type": "non-fungible",
        "tokenSymbol": "TT",
        "decimals": "0",
        "contract": "0.0.8308101"
      },
      {
        "token": "0.0.8308712",
        "count": 3,
        "type": "non-fungible",
        "tokenSymbol": "DD",
        "decimals": "0",
        "contract": "0.0.8308101"
      }
    ],
    "tokenIds": [
      "0.0.8308700",
      "0.0.8308712"
    ],
    "immediately": true,
    "enabled": false,
    "id": "69bd8adb90fe6f912cbb0d05"
  },
  {
    "createDate": "2026-03-20T17:14:31.038Z",
    "updateDate": "2026-03-20T18:00:01.342Z",
    "contractId": "0.0.8308132",
    "tokens": [
      {
        "token": "0.0.8308361",
        "count": 3,
        "type": "fungible",
        "tokenSymbol": "CER",
        "decimals": "0",
        "contract": "0.0.8308101"
      }
    ],
    "tokenIds": [
      "0.0.8308361"
    ],
    "immediately": false,
    "enabled": true,
    "id": "69bd80773090533214e7380e"
  }
]

Clear retire requests.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/retire/{contractId}/requests

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/retire/{contractId}/requests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Set retire pool.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

Body

application/json

tokenstringRequired

countnumberRequired

Responses

200

Successful operation.

No content

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/retire/{contractId}/pools

HTTPcURLJavaScriptPython

POST /api/v1/contracts/retire/{contractId}/pools HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "tokens": [
    {
      "token": "0.0.8300593",
      "count": 1
    }
  ],
  "immediately": true
}

No content

Clear retire pools.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/retire/{contractId}/pools

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/retire/{contractId}/pools HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Unset retire pool.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

poolIdstringRequired

Pool Identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/retire/pools/{poolId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/retire/pools/{poolId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Unset retire request.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

requestIdstringRequired

Request Identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/retire/requests/{requestId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/retire/requests/{requestId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Retire tokens.

post

Retire tokens.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

poolIdstringRequired

Pool Identifier

Example: 652745597a7b53526de37c05

Bodyone of[]

application/json

or

Responses

200

Successful operation. Returns retire pool immediately flag: true — tokens are retired right away; false — retirement requires approval.

application/json

booleanOptional

400

Bad request.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/retire/pools/{poolId}/retire

HTTPcURLJavaScriptPython

POST /api/v1/contracts/retire/pools/{poolId}/retire HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

[
  {
    "token": "0.0.8300593",
    "count": 3,
    "serials": []
  }
]

Fungible token retirement requestNon-fungible token retirement request

No content

Approve retire request.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

requestIdstringRequired

Request identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/retire/requests/{requestId}/approve

HTTPcURLJavaScriptPython

POST /api/v1/contracts/retire/requests/{requestId}/approve HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Cancel retire request.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

requestIdstringRequired

Request identifier

Example: 652745597a7b53526de37c05

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/retire/requests/{requestId}/cancel

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/retire/requests/{requestId}/cancel HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Add retire admin.

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/contracts/retire/{contractId}/admin/{hederaId}

HTTPcURLJavaScriptPython

POST /api/v1/contracts/retire/{contractId}/admin/{hederaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Remove retire admin.

delete

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

contractIdstringRequired

Contract identifier

Example: 652745597a7b53526de37c05

hederaIdstringRequired

Hedera account identifier

Example: 0.0.1

Responses

200

Successful operation.

application/json

booleanOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/contracts/retire/{contractId}/admin/{hederaId}

HTTPcURLJavaScriptPython

DELETE /api/v1/contracts/retire/{contractId}/admin/{hederaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Return a list of all retire vcs.

get

Returns all retire vcs.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0

pageSizenumberRequired

The numbers of items to return

Example: 20

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/contracts/retire

HTTPcURLJavaScriptPython

GET /api/v1/contracts/retire?pageSize=20 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-20T18:36:53.698Z",
    "updateDate": "2026-03-20T18:36:53.698Z",
    "hash": "88chLeeXjKUXa13dNeEJz2tNehsjo3HQGUX5QH3kmY6b",
    "hederaStatus": "NEW",
    "signature": 0,
    "type": "RETIRE",
    "option": {
      "status": "NEW"
    },
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835",
    "document": {
      "id": "urn:uuid:93328f13-cac2-49a8-9c30-fb52842093dd",
      "type": [
        "VerifiableCredential"
      ],
      "issuer": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835",
      "issuanceDate": "2026-03-20T18:36:34.285Z",
      "@context": [
        "https://www.w3.org/2018/credentials/v1",
        "ipfs://bafkreifsj2y32io54zolo4ltcjzu45rg4ejqogpkmbkhb3llzig6dpjf64"
      ],
      "credentialSubject": [
        {
          "user": "0.0.6057669",
          "contractId": "0.0.8308132",
          "tokens": [
            {
              "tokenId": "0.0.8308164",
              "count": 0,
              "serials": [
                2,
                3,
                4,
                10
              ]
            }
          ],
          "@context": [
            "ipfs://bafkreifsj2y32io54zolo4ltcjzu45rg4ejqogpkmbkhb3llzig6dpjf64"
          ],
          "id": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835",
          "type": "Retire"
        }
      ],
      "proof": {
        "type": "Ed25519Signature2018",
        "created": "2026-03-20T18:36:34Z",
        "verificationMethod": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835#did-root-key",
        "proofPurpose": "assertionMethod",
        "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..f71046hE9geZXL7uPc5EIc2YsNGMWsRakFwN_iMht4O6njdQZPtKckkQ6H9P1pZBaRz-_yaAy-gmfO-I3LJDBw"
      }
    },
    "documentFileId": "69bd93c590fe6f912cbb0d36",
    "documentFields": [
      "credentialSubject.0.user"
    ],
    "tableFileIds": [],
    "id": "69bd93c590fe6f912cbb0d38"
  },
  {
    "createDate": "2026-03-20T10:44:47.623Z",
    "updateDate": "2026-03-20T10:44:47.623Z",
    "hash": "7Sj7GyTA7TocoZGfVczb9jSfGhitHKZ133G7pny4nFTV",
    "hederaStatus": "NEW",
    "signature": 0,
    "type": "RETIRE",
    "option": {
      "status": "NEW"
    },
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835",
    "document": {
      "id": "urn:uuid:2e122bba-2f7e-4f46-9ea6-2d790e300caa",
      "type": [
        "VerifiableCredential"
      ],
      "issuer": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835",
      "issuanceDate": "2026-03-20T10:44:31.703Z",
      "@context": [
        "https://www.w3.org/2018/credentials/v1",
        "ipfs://bafkreifsj2y32io54zolo4ltcjzu45rg4ejqogpkmbkhb3llzig6dpjf64"
      ],
      "credentialSubject": [
        {
          "user": "0.0.6057669",
          "contractId": "0.0.8300155",
          "tokens": [
            {
              "tokenId": "0.0.8302213",
              "count": 6,
              "serials": []
            }
          ],
          "@context": [
            "ipfs://bafkreifsj2y32io54zolo4ltcjzu45rg4ejqogpkmbkhb3llzig6dpjf64"
          ],
          "id": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835",
          "type": "Retire"
        }
      ],
      "proof": {
        "type": "Ed25519Signature2018",
        "created": "2026-03-20T10:44:31Z",
        "verificationMethod": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8299835#did-root-key",
        "proofPurpose": "assertionMethod",
        "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..FHaguzWfQoSo2t9SEcAAlJUHNgjtI8_Op189piqVWj_w"
      }
    },
    "documentFileId": "69bd251f5b864fe37954a6f9",
    "documentFields": [
      "credentialSubject.0.user"
    ],
    "tableFileIds": [],
    "id": "69bd251f5b864fe37954a6fb"
  }
]

Return a list of all retire vcs from Indexer.

get

Returns all retire vcs from Indexer.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

contractTopicIdstringRequired

The topic id of contract

Example: 0.0.4641052

Responses

200

Successful operation.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/contracts/retireIndexer

HTTPcURLJavaScriptPython

GET /api/v1/contracts/retireIndexer?contractTopicId=0.0.4641052 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "66ee387945ab8bf9448f45e2",
    "lastUpdate": 0,
    "topicId": "0.0.4641052",
    "consensusTimestamp": "1722418989.344504535",
    "owner": "0.0.1416",
    "uuid": "8494b750-eed6-4d13-82a1-5cc1a644ffae",
    "status": "ISSUE",
    "type": "VC-Document",
    "action": "create-vc-document",
    "lang": "en-US",
    "responseType": "str",
    "options": {
      "issuer": "did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.4640363",
      "relationships": null,
      "documentStatus": null,
      "encodedData": false
    },
    "analytics": {
      "textSearch": "0.0.4641052|0.0.1416|1722418989.344504535|8494b750-eed6-4d13-82a1-5cc1a644ffae|ISSUE|VC-Document|en-US||did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.4640363|0.0.4437864|0.0.4641053|[object Object]|ipfs://bafkreifsj2y32io54zolo4ltcjzu45rg4ejqogpkmbkhb3llzig6dpjf64|did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.4640363|Retire|Retire",
      "schemaId": "1743436678.828522000",
      "schemaName": "Retire"
    },
    "analyticsUpdate": 1773995161141,
    "coordUpdate": 1756843304325,
    "files": [
      "bafkreihwnas7c7ji53iolrjkjuqevqdg2j6je2supras5vghzjq5ccnyai"
    ],
    "documents": [
      {
        "id": "urn:uuid:e7c97bd5-39a3-4f98-b642-b20ec4f81aaf",
        "type": [
          "VerifiableCredential"
        ],
        "issuer": "did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.4640363",
        "issuanceDate": "2024-07-31T09:43:02.117Z",
        "@context": [
          "https://www.w3.org/2018/credentials/v1",
          "ipfs://bafkreifsj2y32io54zolo4ltcjzu45rg4ejqogpkmbkhb3llzig6dpjf64"
        ],
        "credentialSubject": [
          {
            "user": "0.0.4437864",
            "contractId": "0.0.4641053",
            "tokens": [
              {
                "tokenId": "0.0.4641082",
                "count": 0,
                "serials": [
                  23,
                  22,
                  21,
                  20,
                  19
                ],
                "type": "Token",
                "@context": [
                  "ipfs://bafkreifsj2y32io54zolo4ltcjzu45rg4ejqogpkmbkhb3llzig6dpjf64"
                ]
              }
            ],
            "@context": [
              "ipfs://bafkreifsj2y32io54zolo4ltcjzu45rg4ejqogpkmbkhb3llzig6dpjf64"
            ],
            "id": "did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.4640363",
            "type": "Retire"
          }
        ],
        "proof": {
          "type": "Ed25519Signature2018",
          "created": "2024-07-31T09:43:02Z",
          "verificationMethod": "did:hedera:testnet:AGGRsWENUUAqhusdGrfX6R5TuEU8MU56XDyorH2MKZyY_0.0.4640363#did-root-key",
          "proofPurpose": "assertionMethod",
          "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..DGYzJmYogDgbByIERm8cnb_zOJsAKWLg79hW2bkp2mleb57VRaEjm8bOwj9AizlSD4zQzhmXXux7L_nhRO0yCQ"
        }
      }
    ],
    "topics": [],
    "tokens": [],
    "sequenceNumber": 3,
    "loaded": true
  }
]