For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organizations

List organizations owned by the active Standard Registry.

get

Returns a paginated list of organizations owned by the calling Standard Registry. Supports filtering by name (case-insensitive partial match). If the caller is instead an organization administrator (an active member whose OrgRole carries MEMBER_MANAGE), the single organization they administer is also included β€” their discovery path for that organization's id.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
namestringOptional

Filter by organization name (case-insensitive, partial match). Leave empty to return all.

pageIndexnumberOptional

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

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
Responses
200

Successful operation. Returns organizations array and total count in X-Total-Count header.

application/json
get/organizations
GET /api/v1/organizations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "name": "Acme Carbon Co.",
    "description": "Verified carbon-credit issuer for Acme group entities.",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "did": "did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599",
    "walletToken": "text",
    "hederaAccountId": "0.0.6046379",
    "topicId": "0.0.1234567",
    "parentTopicId": "0.0.7654321",
    "status": "PUBLISHED",
    "location": "LOCAL",
    "createDate": "2026-03-03T17:25:53.312Z",
    "updateDate": "2026-03-03T17:25:53.312Z"
  }
]

Create a new (DRAFT) organization.

post

Creates a registry-scoped organization record owned by the calling Standard Registry. The record is created with status DRAFT; on-ledger topic/DID/message publishing is a separate explicit action: POST /organizations/{id}/publish.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired

Human-readable organization name (required)

Example: Acme Carbon Co.
descriptionstringOptional

Optional free-text description

Example: Verified carbon-credit issuer for Acme group entities.
Responses
201

Organization created.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
namestringOptional

Human-readable organization name

Example: Acme Carbon Co.
descriptionstringOptional

Free-text description of the organization

Example: Verified carbon-credit issuer for Acme group entities.
ownerstringOptional

DID of the Standard Registry that owns the organization

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
didstringOptional

DID of the organization (populated after publish)

Example: did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599
walletTokenstringOptional

Vault handle for the organization wallet (server-side identifier; safe to expose)

hederaAccountIdstringOptional

Hedera account ID associated with the organization (populated after publish)

Example: 0.0.6046379
topicIdstringOptional

Hedera topic ID for the organization (populated after publish)

Example: 0.0.1234567
parentTopicIdstringOptional

Parent topic ID (the SR / global topic) the organization topic is linked to

Example: 0.0.7654321
statusstring Β· enumOptional

Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.

Example: PUBLISHEDPossible values:
locationstring Β· enumOptional

Location of the organization record

Example: LOCALPossible values:
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
post/organizations
POST /api/v1/organizations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "name": "Acme Carbon Co.",
  "description": "Verified carbon-credit issuer for Acme group entities."
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "name": "Acme Carbon Co.",
  "description": "Verified carbon-credit issuer for Acme group entities.",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "did": "did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599",
  "walletToken": "text",
  "hederaAccountId": "0.0.6046379",
  "topicId": "0.0.1234567",
  "parentTopicId": "0.0.7654321",
  "status": "PUBLISHED",
  "location": "LOCAL",
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

Get one organization by id.

get

Returns the organization identified by the path parameter. Must be owned by the calling Standard Registry, or the calling organization administrator's own organization (an active member whose OrgRole carries MEMBER_MANAGE).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
namestringOptional

Human-readable organization name

Example: Acme Carbon Co.
descriptionstringOptional

Free-text description of the organization

Example: Verified carbon-credit issuer for Acme group entities.
ownerstringOptional

DID of the Standard Registry that owns the organization

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
didstringOptional

DID of the organization (populated after publish)

Example: did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599
walletTokenstringOptional

Vault handle for the organization wallet (server-side identifier; safe to expose)

hederaAccountIdstringOptional

Hedera account ID associated with the organization (populated after publish)

Example: 0.0.6046379
topicIdstringOptional

Hedera topic ID for the organization (populated after publish)

Example: 0.0.1234567
parentTopicIdstringOptional

Parent topic ID (the SR / global topic) the organization topic is linked to

Example: 0.0.7654321
statusstring Β· enumOptional

Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.

Example: PUBLISHEDPossible values:
locationstring Β· enumOptional

Location of the organization record

Example: LOCALPossible values:
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
get/organizations/{id}
GET /api/v1/organizations/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "name": "Acme Carbon Co.",
  "description": "Verified carbon-credit issuer for Acme group entities.",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "did": "did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599",
  "walletToken": "text",
  "hederaAccountId": "0.0.6046379",
  "topicId": "0.0.1234567",
  "parentTopicId": "0.0.7654321",
  "status": "PUBLISHED",
  "location": "LOCAL",
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

Update an organization (record-layer fields only).

put

Updates the human-readable fields of an organization. On-ledger fields (did, topicId, parentTopicId, hederaAccountId, status, location) are hydrated by the explicit publish action and are not settable here.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
namestringOptional

New organization name

Example: Acme Carbon Co.
descriptionstringOptional

New free-text description

Example: Verified carbon-credit issuer for Acme group entities.
Responses
200

Organization updated.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
namestringOptional

Human-readable organization name

Example: Acme Carbon Co.
descriptionstringOptional

Free-text description of the organization

Example: Verified carbon-credit issuer for Acme group entities.
ownerstringOptional

DID of the Standard Registry that owns the organization

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
didstringOptional

DID of the organization (populated after publish)

Example: did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599
walletTokenstringOptional

Vault handle for the organization wallet (server-side identifier; safe to expose)

hederaAccountIdstringOptional

Hedera account ID associated with the organization (populated after publish)

Example: 0.0.6046379
topicIdstringOptional

Hedera topic ID for the organization (populated after publish)

Example: 0.0.1234567
parentTopicIdstringOptional

Parent topic ID (the SR / global topic) the organization topic is linked to

Example: 0.0.7654321
statusstring Β· enumOptional

Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.

Example: PUBLISHEDPossible values:
locationstring Β· enumOptional

Location of the organization record

Example: LOCALPossible values:
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
put/organizations/{id}
PUT /api/v1/organizations/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "name": "Acme Carbon Co.",
  "description": "Verified carbon-credit issuer for Acme group entities."
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "name": "Acme Carbon Co.",
  "description": "Verified carbon-credit issuer for Acme group entities.",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "did": "did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599",
  "walletToken": "text",
  "hederaAccountId": "0.0.6046379",
  "topicId": "0.0.1234567",
  "parentTopicId": "0.0.7654321",
  "status": "PUBLISHED",
  "location": "LOCAL",
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

Delete an organization.

delete

Deletes the organization and cascades its OrgRoles, OrganizationMembers, and PolicyOrgAssignments at the record layer. Only DRAFT organizations can be deleted; once publishing has begun (PUBLISHED or PUBLISH_ERROR) the organization is permanent β€” a PUBLISH_ERROR organization can be republished, and decommissioning a published organization is future work. Hedera-side artefacts (topic, DID document, on-ledger messages) are immutable and are NOT removed.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Organization deleted. Returns the removed record.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
namestringOptional

Human-readable organization name

Example: Acme Carbon Co.
descriptionstringOptional

Free-text description of the organization

Example: Verified carbon-credit issuer for Acme group entities.
ownerstringOptional

DID of the Standard Registry that owns the organization

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
didstringOptional

DID of the organization (populated after publish)

Example: did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599
walletTokenstringOptional

Vault handle for the organization wallet (server-side identifier; safe to expose)

hederaAccountIdstringOptional

Hedera account ID associated with the organization (populated after publish)

Example: 0.0.6046379
topicIdstringOptional

Hedera topic ID for the organization (populated after publish)

Example: 0.0.1234567
parentTopicIdstringOptional

Parent topic ID (the SR / global topic) the organization topic is linked to

Example: 0.0.7654321
statusstring Β· enumOptional

Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.

Example: PUBLISHEDPossible values:
locationstring Β· enumOptional

Location of the organization record

Example: LOCALPossible values:
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
delete/organizations/{id}
DELETE /api/v1/organizations/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "name": "Acme Carbon Co.",
  "description": "Verified carbon-credit issuer for Acme group entities.",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "did": "did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599",
  "walletToken": "text",
  "hederaAccountId": "0.0.6046379",
  "topicId": "0.0.1234567",
  "parentTopicId": "0.0.7654321",
  "status": "PUBLISHED",
  "location": "LOCAL",
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

Publish a DRAFT organization on the ledger.

post

Creates the organization topic under the SR/global topic, publishes the organization DID and OrganizationMessage, stores the Hedera key in the org wallet, and persists the hydrated record (status PUBLISHED) as the final step. If publishing fails after the first ledger write the organization is marked PUBLISH_ERROR and can be republished (a retry creates a fresh topic/DID set). The provided Hedera key is stored securely and never echoed.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
hederaAccountIdstringRequired

Hedera account ID to associate with the organization (operator account)

Example: 0.0.6046379
hederaAccountKeystringRequired

Private key for the Hedera account (stored securely in the org wallet, never echoed)

descriptionstringOptional

Optional description override applied during publish

Example: Verified carbon-credit issuer for Acme group entities.
Responses
200

Organization published. Returns the hydrated record.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
namestringOptional

Human-readable organization name

Example: Acme Carbon Co.
descriptionstringOptional

Free-text description of the organization

Example: Verified carbon-credit issuer for Acme group entities.
ownerstringOptional

DID of the Standard Registry that owns the organization

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
didstringOptional

DID of the organization (populated after publish)

Example: did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599
walletTokenstringOptional

Vault handle for the organization wallet (server-side identifier; safe to expose)

hederaAccountIdstringOptional

Hedera account ID associated with the organization (populated after publish)

Example: 0.0.6046379
topicIdstringOptional

Hedera topic ID for the organization (populated after publish)

Example: 0.0.1234567
parentTopicIdstringOptional

Parent topic ID (the SR / global topic) the organization topic is linked to

Example: 0.0.7654321
statusstring Β· enumOptional

Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.

Example: PUBLISHEDPossible values:
locationstring Β· enumOptional

Location of the organization record

Example: LOCALPossible values:
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
post/organizations/{id}/publish
POST /api/v1/organizations/{id}/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "hederaAccountId": "0.0.6046379",
  "hederaAccountKey": "text",
  "description": "Verified carbon-credit issuer for Acme group entities."
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "name": "Acme Carbon Co.",
  "description": "Verified carbon-credit issuer for Acme group entities.",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "did": "did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599",
  "walletToken": "text",
  "hederaAccountId": "0.0.6046379",
  "topicId": "0.0.1234567",
  "parentTopicId": "0.0.7654321",
  "status": "PUBLISHED",
  "location": "LOCAL",
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

List roles under an organization.

get

Returns all OrgRoles defined under the organization. Callable by the owning Standard Registry, or by an organization administrator (an active member whose OrgRole carries MEMBER_MANAGE) for their own organization.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Parent organization identifier

Example: 69b8115f3dc0fa022156fb89
namestringOptional

Role name (unique within the organization)

Example: Manager
descriptionstringOptional

Free-text role description

Example: Operators authorized to mint on behalf of the organization.
permissionsstring[]Optional

Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE

Example: ["TOKEN_MINTING","TOKEN_TRANSFER"]
get/organizations/{id}/roles
GET /api/v1/organizations/{id}/roles HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "organizationId": "69b8115f3dc0fa022156fb89",
    "name": "Manager",
    "description": "Operators authorized to mint on behalf of the organization.",
    "permissions": [
      "TOKEN_MINTING",
      "TOKEN_TRANSFER"
    ]
  }
]

Create a role under an organization.

post

Creates a named role under the organization with a subset of OrgRolePermission (TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE). MEMBER_MANAGE makes members holding the role organization administrators, able to manage their own organization's non-admin membership; granting or revoking it is always Standard-Registry-only. Role names are unique within an organization.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
namestringRequired

Role name (required, unique within the organization)

Example: Manager
descriptionstringOptional

Optional free-text description

Example: Operators authorized to mint on behalf of the organization.
permissionsstring[]Optional

Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE

Example: ["TOKEN_MINTING"]
Responses
201

Role created.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Parent organization identifier

Example: 69b8115f3dc0fa022156fb89
namestringOptional

Role name (unique within the organization)

Example: Manager
descriptionstringOptional

Free-text role description

Example: Operators authorized to mint on behalf of the organization.
permissionsstring[]Optional

Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE

Example: ["TOKEN_MINTING","TOKEN_TRANSFER"]
post/organizations/{id}/roles
POST /api/v1/organizations/{id}/roles HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "name": "Manager",
  "description": "Operators authorized to mint on behalf of the organization.",
  "permissions": [
    "TOKEN_MINTING"
  ]
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "organizationId": "69b8115f3dc0fa022156fb89",
  "name": "Manager",
  "description": "Operators authorized to mint on behalf of the organization.",
  "permissions": [
    "TOKEN_MINTING",
    "TOKEN_TRANSFER"
  ]
}

Update an organization role.

put

Updates the name, description, or permissions of an OrgRole. A name change propagates to the denormalized OrganizationMember.orgRoleName on all existing members.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
roleIdstringRequired

OrgRole identifier

Example: 69b8115f3dc0fa022156fb89
Body
namestringOptional

New role name (must be unique within the organization)

Example: Manager
descriptionstringOptional

New free-text description

Example: Operators authorized to mint on behalf of the organization.
permissionsstring[]Optional

New permissions list β€” subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE

Example: ["TOKEN_MINTING","TOKEN_TRANSFER"]
Responses
200

Role updated.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Parent organization identifier

Example: 69b8115f3dc0fa022156fb89
namestringOptional

Role name (unique within the organization)

Example: Manager
descriptionstringOptional

Free-text role description

Example: Operators authorized to mint on behalf of the organization.
permissionsstring[]Optional

Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE

Example: ["TOKEN_MINTING","TOKEN_TRANSFER"]
put/organizations/{id}/roles/{roleId}
PUT /api/v1/organizations/{id}/roles/{roleId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "name": "Manager",
  "description": "Operators authorized to mint on behalf of the organization.",
  "permissions": [
    "TOKEN_MINTING",
    "TOKEN_TRANSFER"
  ]
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "organizationId": "69b8115f3dc0fa022156fb89",
  "name": "Manager",
  "description": "Operators authorized to mint on behalf of the organization.",
  "permissions": [
    "TOKEN_MINTING",
    "TOKEN_TRANSFER"
  ]
}

Delete an organization role.

delete

Removes an OrgRole. The operation is refused if any active OrganizationMember is still assigned to the role; re-assign or remove those members first.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
roleIdstringRequired

OrgRole identifier

Example: 69b8115f3dc0fa022156fb89
Responses
200

Role deleted. Returns the removed record.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Parent organization identifier

Example: 69b8115f3dc0fa022156fb89
namestringOptional

Role name (unique within the organization)

Example: Manager
descriptionstringOptional

Free-text role description

Example: Operators authorized to mint on behalf of the organization.
permissionsstring[]Optional

Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE

Example: ["TOKEN_MINTING","TOKEN_TRANSFER"]
delete/organizations/{id}/roles/{roleId}
DELETE /api/v1/organizations/{id}/roles/{roleId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "organizationId": "69b8115f3dc0fa022156fb89",
  "name": "Manager",
  "description": "Operators authorized to mint on behalf of the organization.",
  "permissions": [
    "TOKEN_MINTING",
    "TOKEN_TRANSFER"
  ]
}

List members of an organization.

get

Returns a paginated list of OrganizationMember rows. Supports filtering by active flag, OrgRole id, and member DID. Callable by the owning Standard Registry, or by an organization administrator (an active member whose OrgRole carries MEMBER_MANAGE) for their own organization.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Query parameters
orgRoleIdstringOptional

Filter by OrgRole identifier.

Example: 69b8115f3dc0fa022156fb89
didstringOptional

Filter by member DID.

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
pageIndexnumberOptional

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

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
activebooleanOptional

Filter by active flag (true/false). Omit to return all.

Example: true
Responses
200

Successful operation. Returns members array and total count in X-Total-Count header.

application/json
get/organizations/{id}/members
GET /api/v1/organizations/{id}/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "organizationId": "69b8115f3dc0fa022156fb89",
    "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "userId": "69b7da996d2f71c7a55b1fa3",
    "username": "jane.doe",
    "orgRoleId": "69b8115f3dc0fa022156fb89",
    "orgRoleName": "Manager",
    "active": true,
    "messageId": "1700000000.000000000",
    "createDate": "2026-03-03T17:25:53.312Z",
    "updateDate": "2026-03-03T17:25:53.312Z"
  }
]

Enroll a user as a member of an organization.

post

Validates the member first (user exists, not already in an organization), then publishes a RegistrationMessage(Init) on the organization topic (carrying member DID + role name as attributes), then persists the OrganizationMember record with the resulting messageId. A user can belong to at most one organization (enforced by @Unique(did)). Callable by the owning Standard Registry (no restriction), or by an organization administrator (an active member whose OrgRole carries MEMBER_MANAGE) enrolling into their own organization β€” subject to server-side rules: an admin cannot assign a role that itself carries MEMBER_MANAGE, and the assigned role's permissions must be a subset of the admin's own role's permissions.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
didstringRequired

DID of the user to enroll (must already exist as a Guardian user)

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
orgRoleIdstringRequired

Identifier of the OrgRole to assign to the new member

Example: 69b8115f3dc0fa022156fb89
Responses
201

Member enrolled.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Parent organization identifier

Example: 69b8115f3dc0fa022156fb89
didstringOptional

Member DID

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
userIdstringOptional

Underlying user identifier (auth-service User._id)

Example: 69b7da996d2f71c7a55b1fa3
usernamestringOptional

Username (denormalized for display)

Example: jane.doe
orgRoleIdstringOptional

OrgRole identifier the member is enrolled in

Example: 69b8115f3dc0fa022156fb89
orgRoleNamestringOptional

OrgRole name (denormalized for display)

Example: Manager
activebooleanOptional

Whether the membership is active

Example: true
messageIdstringOptional

Identifier of the RegistrationMessage(Init) published on the org topic

Example: 1700000000.000000000
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
post/organizations/{id}/members
POST /api/v1/organizations/{id}/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "orgRoleId": "69b8115f3dc0fa022156fb89"
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "organizationId": "69b8115f3dc0fa022156fb89",
  "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "userId": "69b7da996d2f71c7a55b1fa3",
  "username": "jane.doe",
  "orgRoleId": "69b8115f3dc0fa022156fb89",
  "orgRoleName": "Manager",
  "active": true,
  "messageId": "1700000000.000000000",
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

Get an organization member by id.

get

Returns one OrganizationMember row by its database identifier. Scoped via the parent organization: the owning Standard Registry, or an organization administrator (an active member whose OrgRole carries MEMBER_MANAGE) for their own organization.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
memberIdstringRequired

OrganizationMember identifier

Example: 69b8115f3dc0fa022156fb89
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Parent organization identifier

Example: 69b8115f3dc0fa022156fb89
didstringOptional

Member DID

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
userIdstringOptional

Underlying user identifier (auth-service User._id)

Example: 69b7da996d2f71c7a55b1fa3
usernamestringOptional

Username (denormalized for display)

Example: jane.doe
orgRoleIdstringOptional

OrgRole identifier the member is enrolled in

Example: 69b8115f3dc0fa022156fb89
orgRoleNamestringOptional

OrgRole name (denormalized for display)

Example: Manager
activebooleanOptional

Whether the membership is active

Example: true
messageIdstringOptional

Identifier of the RegistrationMessage(Init) published on the org topic

Example: 1700000000.000000000
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
get/organizations/{id}/members/{memberId}
GET /api/v1/organizations/{id}/members/{memberId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "organizationId": "69b8115f3dc0fa022156fb89",
  "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "userId": "69b7da996d2f71c7a55b1fa3",
  "username": "jane.doe",
  "orgRoleId": "69b8115f3dc0fa022156fb89",
  "orgRoleName": "Manager",
  "active": true,
  "messageId": "1700000000.000000000",
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

Remove an organization member.

delete

Removes an OrganizationMember row. The delete is hard (not soft) so the @Unique(did) constraint is freed and the user can be enrolled in another organization. Callable by the owning Standard Registry (no restriction), or by an organization administrator (an active member whose OrgRole carries MEMBER_MANAGE) removing a member of their own organization β€” subject to server-side rules: an admin cannot remove a member who currently holds MEMBER_MANAGE (including themselves).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
memberIdstringRequired

OrganizationMember identifier

Example: 69b8115f3dc0fa022156fb89
Responses
200

Member removed. Returns the removed record.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Parent organization identifier

Example: 69b8115f3dc0fa022156fb89
didstringOptional

Member DID

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
userIdstringOptional

Underlying user identifier (auth-service User._id)

Example: 69b7da996d2f71c7a55b1fa3
usernamestringOptional

Username (denormalized for display)

Example: jane.doe
orgRoleIdstringOptional

OrgRole identifier the member is enrolled in

Example: 69b8115f3dc0fa022156fb89
orgRoleNamestringOptional

OrgRole name (denormalized for display)

Example: Manager
activebooleanOptional

Whether the membership is active

Example: true
messageIdstringOptional

Identifier of the RegistrationMessage(Init) published on the org topic

Example: 1700000000.000000000
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
delete/organizations/{id}/members/{memberId}
DELETE /api/v1/organizations/{id}/members/{memberId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "organizationId": "69b8115f3dc0fa022156fb89",
  "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "userId": "69b7da996d2f71c7a55b1fa3",
  "username": "jane.doe",
  "orgRoleId": "69b8115f3dc0fa022156fb89",
  "orgRoleName": "Manager",
  "active": true,
  "messageId": "1700000000.000000000",
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

Update an organization member's role.

put

Re-assigns the OrgRole of an existing OrganizationMember. The new role must belong to the same organization. Callable by the owning Standard Registry (no restriction), or by an organization administrator (an active member whose OrgRole carries MEMBER_MANAGE) re-assigning a member of their own organization β€” subject to server-side rules: an admin cannot re-role a member who currently holds MEMBER_MANAGE (including themselves) or assign a role that itself carries MEMBER_MANAGE, and the new role's permissions must be a subset of the admin's own role's permissions.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
memberIdstringRequired

OrganizationMember identifier

Example: 69b8115f3dc0fa022156fb89
Body
orgRoleIdstringRequired

Identifier of the new OrgRole (must belong to the same organization)

Example: 69b8115f3dc0fa022156fb89
Responses
200

Member role updated.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Parent organization identifier

Example: 69b8115f3dc0fa022156fb89
didstringOptional

Member DID

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
userIdstringOptional

Underlying user identifier (auth-service User._id)

Example: 69b7da996d2f71c7a55b1fa3
usernamestringOptional

Username (denormalized for display)

Example: jane.doe
orgRoleIdstringOptional

OrgRole identifier the member is enrolled in

Example: 69b8115f3dc0fa022156fb89
orgRoleNamestringOptional

OrgRole name (denormalized for display)

Example: Manager
activebooleanOptional

Whether the membership is active

Example: true
messageIdstringOptional

Identifier of the RegistrationMessage(Init) published on the org topic

Example: 1700000000.000000000
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
put/organizations/{id}/members/{memberId}/role
PUT /api/v1/organizations/{id}/members/{memberId}/role HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "orgRoleId": "69b8115f3dc0fa022156fb89"
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "organizationId": "69b8115f3dc0fa022156fb89",
  "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "userId": "69b7da996d2f71c7a55b1fa3",
  "username": "jane.doe",
  "orgRoleId": "69b8115f3dc0fa022156fb89",
  "orgRoleName": "Manager",
  "active": true,
  "messageId": "1700000000.000000000",
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

Assign a policy to an organization.

post

Creates a PolicyOrgAssignment row that grants current and future members of the organization visibility into the policy and open/execute access to it. Does NOT auto-enroll members into policy groups (PolicyRoles group selection still applies on first entry). Idempotent: an existing assignment is returned unchanged; a previously revoked assignment is reactivated.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
policyIdstringRequired

Identifier of the policy to assign to the organization

Example: 69b7da996d2f71c7a55b1fa3
Responses
201

Policy assigned.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Organization identifier

Example: 69b8115f3dc0fa022156fb89
policyIdstringOptional

Policy identifier

Example: 69b7da996d2f71c7a55b1fa3
ownerstringOptional

DID of the Standard Registry that created the assignment

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
assignedbooleanOptional

Whether the assignment is currently active (false = soft-revoked)

Example: true
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
post/organizations/{id}/policies/assign
POST /api/v1/organizations/{id}/policies/assign HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "policyId": "69b7da996d2f71c7a55b1fa3"
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "organizationId": "69b8115f3dc0fa022156fb89",
  "policyId": "69b7da996d2f71c7a55b1fa3",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "assigned": true,
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

Revoke a policy assignment from an organization.

delete

Soft-revokes a PolicyOrgAssignment by setting assigned=false; the row is kept for audit purposes and can be reactivated by re-assigning the same policy.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
policyIdstringRequired

Policy identifier

Example: 69b7da996d2f71c7a55b1fa3
Responses
200

Assignment revoked. Returns the updated record (assigned=false).

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Organization identifier

Example: 69b8115f3dc0fa022156fb89
policyIdstringOptional

Policy identifier

Example: 69b7da996d2f71c7a55b1fa3
ownerstringOptional

DID of the Standard Registry that created the assignment

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
assignedbooleanOptional

Whether the assignment is currently active (false = soft-revoked)

Example: true
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
delete/organizations/{id}/policies/{policyId}
DELETE /api/v1/organizations/{id}/policies/{policyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "organizationId": "69b8115f3dc0fa022156fb89",
  "policyId": "69b7da996d2f71c7a55b1fa3",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "assigned": true,
  "createDate": "2026-03-03T17:25:53.312Z",
  "updateDate": "2026-03-03T17:25:53.312Z"
}

List policies assigned to an organization.

get

Returns the PolicyOrgAssignment rows for an organization. By default only active assignments are returned; pass includeRevoked=true to include soft-revoked rows.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
Query parameters
includeRevokedbooleanOptional

Set to true to include soft-revoked assignments.

Example: false
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
organizationIdstringOptional

Organization identifier

Example: 69b8115f3dc0fa022156fb89
policyIdstringOptional

Policy identifier

Example: 69b7da996d2f71c7a55b1fa3
ownerstringOptional

DID of the Standard Registry that created the assignment

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
assignedbooleanOptional

Whether the assignment is currently active (false = soft-revoked)

Example: true
createDatestringOptional

Creation date in ISO 8601 format

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

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z
get/organizations/{id}/policies
GET /api/v1/organizations/{id}/policies HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "organizationId": "69b8115f3dc0fa022156fb89",
    "policyId": "69b7da996d2f71c7a55b1fa3",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "assigned": true,
    "createDate": "2026-03-03T17:25:53.312Z",
    "updateDate": "2026-03-03T17:25:53.312Z"
  }
]

Associate a token with the organization's Hedera wallet.

put

Associates the provided token with the organization's Hedera account. Requires the caller to be an active member of the organization whose OrgRole carries TOKEN_ASSOCIATE, or the organization's owner (always allowed).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Token identifier

Example: 69b8115f3dc0fa022156fb89
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring Β· enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/organizations/{id}/tokens/{tokenId}/associate
PUT /api/v1/organizations/{id}/tokens/{tokenId}/associate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "tokenId": "0.0.6046500",
  "tokenName": "Carbon Credit Token",
  "tokenSymbol": "CCT",
  "tokenType": "fungible",
  "decimals": "2",
  "associated": true,
  "frozen": false,
  "kyc": true,
  "balance": "1000.50",
  "enableAdmin": true,
  "enableFreeze": false,
  "enableKYC": true,
  "enableWipe": true
}

Dissociate a token from the organization's Hedera wallet.

put

Dissociates the provided token from the organization's Hedera account. Requires the caller to be an active member of the organization whose OrgRole carries TOKEN_DISSOCIATE, or the organization's owner (always allowed).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Token identifier

Example: 69b8115f3dc0fa022156fb89
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring Β· enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/organizations/{id}/tokens/{tokenId}/dissociate
PUT /api/v1/organizations/{id}/tokens/{tokenId}/dissociate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "tokenId": "0.0.6046500",
  "tokenName": "Carbon Credit Token",
  "tokenSymbol": "CCT",
  "tokenType": "fungible",
  "decimals": "2",
  "associated": true,
  "frozen": false,
  "kyc": true,
  "balance": "1000.50",
  "enableAdmin": true,
  "enableFreeze": false,
  "enableKYC": true,
  "enableWipe": true
}

Grant KYC for a token to the organization's Hedera wallet.

put

Sets the KYC flag for the organization's Hedera account on the provided token. Requires the caller to be the organization's owner (Standard Registry) and the owner of the token's KYC key.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Token identifier

Example: 69b8115f3dc0fa022156fb89
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring Β· enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/organizations/{id}/tokens/{tokenId}/grant-kyc
PUT /api/v1/organizations/{id}/tokens/{tokenId}/grant-kyc HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "tokenId": "0.0.6046500",
  "tokenName": "Carbon Credit Token",
  "tokenSymbol": "CCT",
  "tokenType": "fungible",
  "decimals": "2",
  "associated": true,
  "frozen": false,
  "kyc": true,
  "balance": "1000.50",
  "enableAdmin": true,
  "enableFreeze": false,
  "enableKYC": true,
  "enableWipe": true
}

Revoke KYC for a token from the organization's Hedera wallet.

put

Unsets the KYC flag for the organization's Hedera account on the provided token. Requires the caller to be the organization's owner (Standard Registry) and the owner of the token's KYC key.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Token identifier

Example: 69b8115f3dc0fa022156fb89
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Hedera token ID

Example: 0.0.6046500
tokenNamestringRequired

Human-readable name of the token

Example: Carbon Credit Token
tokenSymbolstringRequired

Short ticker symbol for the token

Example: CCT
tokenTypestring Β· enumRequired

Token type on Hedera

Example: fungiblePossible values:
decimalsstringRequired

Number of decimal places

Example: 2
associatedbooleanRequired

Whether the current user is associated with this token

Example: true
frozenbooleanRequired

Whether the current user's account is frozen for this token

Example: false
kycbooleanRequired

Whether the current user has passed KYC for this token

Example: true
balancestringRequired

Current token balance for the user

Example: 1000.50
enableAdminbooleanRequired

Whether the token has an Admin key

Example: true
enableFreezebooleanRequired

Whether the token has a Freeze key

Example: false
enableKYCbooleanRequired

Whether the token has a KYC key

Example: true
enableWipebooleanRequired

Whether the token has a Wipe key

Example: true
put/organizations/{id}/tokens/{tokenId}/revoke-kyc
PUT /api/v1/organizations/{id}/tokens/{tokenId}/revoke-kyc HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "tokenId": "0.0.6046500",
  "tokenName": "Carbon Credit Token",
  "tokenSymbol": "CCT",
  "tokenType": "fungible",
  "decimals": "2",
  "associated": true,
  "frozen": false,
  "kyc": true,
  "balance": "1000.50",
  "enableAdmin": true,
  "enableFreeze": false,
  "enableKYC": true,
  "enableWipe": true
}

Transfers tokens from the organization's Hedera wallet to a target account.

post

Transfers fungible or non-fungible tokens FROM the organization's Hedera account to the specified target account, signed with the organization's key. Requires the caller to be an active member of the organization whose OrgRole carries TOKEN_TRANSFER, or the organization's owner (always allowed). For FT specify amount; for NFT specify serialNumbers, or amount to pick that many of the highest-numbered owned serials (max 10 per request).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Organization identifier

Example: 69aeb71ef8c5b278e3bab4e5
tokenIdstringRequired

Token identifier

Example: 69b8115f3dc0fa022156fb89
Body
targetAccountstringRequired

Target Hedera account ID

Example: 0.0.12345
amountnumberOptional

Amount (FT) or serial count to pick (NFT); must be > 0

Example: 10
serialNumbersnumber[]Optional

Specific NFT serial numbers to transfer; positive integers

Example: [1,2,3]
memostringOptional

Optional transaction memo

Responses
200

Successful operation.

No content

post/organizations/{id}/tokens/{tokenId}/transfer
POST /api/v1/organizations/{id}/tokens/{tokenId}/transfer HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "targetAccount": "0.0.12345",
  "amount": 10,
  "serialNumbers": [
    1,
    2,
    3
  ],
  "memo": "text"
}

No content

Last updated