Organizations
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.
Filter by organization name (case-insensitive, partial match). Leave empty to return all.
The number of pages to skip before starting to collect the result set
0The numbers of items to return
20Successful operation. Returns organizations array and total count in X-Total-Count header.
Unauthorized request.
Forbidden
Internal server error.
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"
}
]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.
Human-readable organization name (required)
Acme Carbon Co.Optional free-text description
Verified carbon-credit issuer for Acme group entities.Organization created.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Human-readable organization name
Acme Carbon Co.Free-text description of the organization
Verified carbon-credit issuer for Acme group entities.DID of the Standard Registry that owns the organization
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599DID of the organization (populated after publish)
did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599Vault handle for the organization wallet (server-side identifier; safe to expose)
Hedera account ID associated with the organization (populated after publish)
0.0.6046379Hedera topic ID for the organization (populated after publish)
0.0.1234567Parent topic ID (the SR / global topic) the organization topic is linked to
0.0.7654321Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.
PUBLISHEDPossible values: Location of the organization record
LOCALPossible values: Creation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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).
Organization identifier
69aeb71ef8c5b278e3bab4e5Successful operation.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Human-readable organization name
Acme Carbon Co.Free-text description of the organization
Verified carbon-credit issuer for Acme group entities.DID of the Standard Registry that owns the organization
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599DID of the organization (populated after publish)
did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599Vault handle for the organization wallet (server-side identifier; safe to expose)
Hedera account ID associated with the organization (populated after publish)
0.0.6046379Hedera topic ID for the organization (populated after publish)
0.0.1234567Parent topic ID (the SR / global topic) the organization topic is linked to
0.0.7654321Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.
PUBLISHEDPossible values: Location of the organization record
LOCALPossible values: Creation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5New organization name
Acme Carbon Co.New free-text description
Verified carbon-credit issuer for Acme group entities.Organization updated.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Human-readable organization name
Acme Carbon Co.Free-text description of the organization
Verified carbon-credit issuer for Acme group entities.DID of the Standard Registry that owns the organization
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599DID of the organization (populated after publish)
did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599Vault handle for the organization wallet (server-side identifier; safe to expose)
Hedera account ID associated with the organization (populated after publish)
0.0.6046379Hedera topic ID for the organization (populated after publish)
0.0.1234567Parent topic ID (the SR / global topic) the organization topic is linked to
0.0.7654321Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.
PUBLISHEDPossible values: Location of the organization record
LOCALPossible values: Creation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5Organization deleted. Returns the removed record.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Human-readable organization name
Acme Carbon Co.Free-text description of the organization
Verified carbon-credit issuer for Acme group entities.DID of the Standard Registry that owns the organization
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599DID of the organization (populated after publish)
did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599Vault handle for the organization wallet (server-side identifier; safe to expose)
Hedera account ID associated with the organization (populated after publish)
0.0.6046379Hedera topic ID for the organization (populated after publish)
0.0.1234567Parent topic ID (the SR / global topic) the organization topic is linked to
0.0.7654321Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.
PUBLISHEDPossible values: Location of the organization record
LOCALPossible values: Creation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5Hedera account ID to associate with the organization (operator account)
0.0.6046379Private key for the Hedera account (stored securely in the org wallet, never echoed)
Optional description override applied during publish
Verified carbon-credit issuer for Acme group entities.Organization published. Returns the hydrated record.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Human-readable organization name
Acme Carbon Co.Free-text description of the organization
Verified carbon-credit issuer for Acme group entities.DID of the Standard Registry that owns the organization
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599DID of the organization (populated after publish)
did:hedera:testnet:EthnLQfQnh8x6vKyegyekhy72oSAok6cH59pfVssKLDw_0.0.8200599Vault handle for the organization wallet (server-side identifier; safe to expose)
Hedera account ID associated with the organization (populated after publish)
0.0.6046379Hedera topic ID for the organization (populated after publish)
0.0.1234567Parent topic ID (the SR / global topic) the organization topic is linked to
0.0.7654321Lifecycle status of the organization. PUBLISH_ERROR indicates a failed publish attempt; the organization can be republished.
PUBLISHEDPossible values: Location of the organization record
LOCALPossible values: Creation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5Successful operation.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Parent organization identifier
69b8115f3dc0fa022156fb89Role name (unique within the organization)
ManagerFree-text role description
Operators authorized to mint on behalf of the organization.Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE
["TOKEN_MINTING","TOKEN_TRANSFER"]Unauthorized request.
Forbidden
Internal server error.
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"
]
}
]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.
Organization identifier
69aeb71ef8c5b278e3bab4e5Role name (required, unique within the organization)
ManagerOptional free-text description
Operators authorized to mint on behalf of the organization.Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE
["TOKEN_MINTING"]Role created.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Parent organization identifier
69b8115f3dc0fa022156fb89Role name (unique within the organization)
ManagerFree-text role description
Operators authorized to mint on behalf of the organization.Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE
["TOKEN_MINTING","TOKEN_TRANSFER"]Unauthorized request.
Forbidden
Internal server error.
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"
]
}Updates the name, description, or permissions of an OrgRole. A name change propagates to the denormalized OrganizationMember.orgRoleName on all existing members.
Organization identifier
69aeb71ef8c5b278e3bab4e5OrgRole identifier
69b8115f3dc0fa022156fb89New role name (must be unique within the organization)
ManagerNew free-text description
Operators authorized to mint on behalf of the organization.New permissions list β subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE
["TOKEN_MINTING","TOKEN_TRANSFER"]Role updated.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Parent organization identifier
69b8115f3dc0fa022156fb89Role name (unique within the organization)
ManagerFree-text role description
Operators authorized to mint on behalf of the organization.Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE
["TOKEN_MINTING","TOKEN_TRANSFER"]Unauthorized request.
Forbidden
Internal server error.
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"
]
}Removes an OrgRole. The operation is refused if any active OrganizationMember is still assigned to the role; re-assign or remove those members first.
Organization identifier
69aeb71ef8c5b278e3bab4e5OrgRole identifier
69b8115f3dc0fa022156fb89Role deleted. Returns the removed record.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Parent organization identifier
69b8115f3dc0fa022156fb89Role name (unique within the organization)
ManagerFree-text role description
Operators authorized to mint on behalf of the organization.Subset of TOKEN_MINTING, TOKEN_RETIREMENT, TOKEN_TRANSFER, TOKEN_ASSOCIATE, TOKEN_DISSOCIATE, MEMBER_MANAGE
["TOKEN_MINTING","TOKEN_TRANSFER"]Unauthorized request.
Forbidden
Internal server error.
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"
]
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5Filter by OrgRole identifier.
69b8115f3dc0fa022156fb89Filter by member DID.
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599The number of pages to skip before starting to collect the result set
0The numbers of items to return
20Filter by active flag (true/false). Omit to return all.
trueSuccessful operation. Returns members array and total count in X-Total-Count header.
Unauthorized request.
Forbidden
Internal server error.
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"
}
]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.
Organization identifier
69aeb71ef8c5b278e3bab4e5DID of the user to enroll (must already exist as a Guardian user)
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599Identifier of the OrgRole to assign to the new member
69b8115f3dc0fa022156fb89Member enrolled.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Parent organization identifier
69b8115f3dc0fa022156fb89Member DID
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599Underlying user identifier (auth-service User._id)
69b7da996d2f71c7a55b1fa3Username (denormalized for display)
jane.doeOrgRole identifier the member is enrolled in
69b8115f3dc0fa022156fb89OrgRole name (denormalized for display)
ManagerWhether the membership is active
trueIdentifier of the RegistrationMessage(Init) published on the org topic
1700000000.000000000Creation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5OrganizationMember identifier
69b8115f3dc0fa022156fb89Successful operation.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Parent organization identifier
69b8115f3dc0fa022156fb89Member DID
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599Underlying user identifier (auth-service User._id)
69b7da996d2f71c7a55b1fa3Username (denormalized for display)
jane.doeOrgRole identifier the member is enrolled in
69b8115f3dc0fa022156fb89OrgRole name (denormalized for display)
ManagerWhether the membership is active
trueIdentifier of the RegistrationMessage(Init) published on the org topic
1700000000.000000000Creation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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).
Organization identifier
69aeb71ef8c5b278e3bab4e5OrganizationMember identifier
69b8115f3dc0fa022156fb89Member removed. Returns the removed record.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Parent organization identifier
69b8115f3dc0fa022156fb89Member DID
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599Underlying user identifier (auth-service User._id)
69b7da996d2f71c7a55b1fa3Username (denormalized for display)
jane.doeOrgRole identifier the member is enrolled in
69b8115f3dc0fa022156fb89OrgRole name (denormalized for display)
ManagerWhether the membership is active
trueIdentifier of the RegistrationMessage(Init) published on the org topic
1700000000.000000000Creation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5OrganizationMember identifier
69b8115f3dc0fa022156fb89Identifier of the new OrgRole (must belong to the same organization)
69b8115f3dc0fa022156fb89Member role updated.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Parent organization identifier
69b8115f3dc0fa022156fb89Member DID
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599Underlying user identifier (auth-service User._id)
69b7da996d2f71c7a55b1fa3Username (denormalized for display)
jane.doeOrgRole identifier the member is enrolled in
69b8115f3dc0fa022156fb89OrgRole name (denormalized for display)
ManagerWhether the membership is active
trueIdentifier of the RegistrationMessage(Init) published on the org topic
1700000000.000000000Creation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5Identifier of the policy to assign to the organization
69b7da996d2f71c7a55b1fa3Policy assigned.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Organization identifier
69b8115f3dc0fa022156fb89Policy identifier
69b7da996d2f71c7a55b1fa3DID of the Standard Registry that created the assignment
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599Whether the assignment is currently active (false = soft-revoked)
trueCreation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5Policy identifier
69b7da996d2f71c7a55b1fa3Assignment revoked. Returns the updated record (assigned=false).
Internal database identifier
69aeb71ef8c5b278e3bab4e5Organization identifier
69b8115f3dc0fa022156fb89Policy identifier
69b7da996d2f71c7a55b1fa3DID of the Standard Registry that created the assignment
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599Whether the assignment is currently active (false = soft-revoked)
trueCreation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}Returns the PolicyOrgAssignment rows for an organization. By default only active assignments are returned; pass includeRevoked=true to include soft-revoked rows.
Organization identifier
69aeb71ef8c5b278e3bab4e5Set to true to include soft-revoked assignments.
falseSuccessful operation.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Organization identifier
69b8115f3dc0fa022156fb89Policy identifier
69b7da996d2f71c7a55b1fa3DID of the Standard Registry that created the assignment
did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599Whether the assignment is currently active (false = soft-revoked)
trueCreation date in ISO 8601 format
2026-03-03T17:25:53.312ZLast update date in ISO 8601 format
2026-03-03T17:25:53.312ZUnauthorized request.
Forbidden
Internal server error.
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"
}
]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).
Organization identifier
69aeb71ef8c5b278e3bab4e5Token identifier
69b8115f3dc0fa022156fb89Successful operation.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Hedera token ID
0.0.6046500Human-readable name of the token
Carbon Credit TokenShort ticker symbol for the token
CCTToken type on Hedera
fungiblePossible values: Number of decimal places
2Whether the current user is associated with this token
trueWhether the current user's account is frozen for this token
falseWhether the current user has passed KYC for this token
trueCurrent token balance for the user
1000.50Whether the token has an Admin key
trueWhether the token has a Freeze key
falseWhether the token has a KYC key
trueWhether the token has a Wipe key
trueUnauthorized request.
Forbidden
Internal server error.
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
}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).
Organization identifier
69aeb71ef8c5b278e3bab4e5Token identifier
69b8115f3dc0fa022156fb89Successful operation.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Hedera token ID
0.0.6046500Human-readable name of the token
Carbon Credit TokenShort ticker symbol for the token
CCTToken type on Hedera
fungiblePossible values: Number of decimal places
2Whether the current user is associated with this token
trueWhether the current user's account is frozen for this token
falseWhether the current user has passed KYC for this token
trueCurrent token balance for the user
1000.50Whether the token has an Admin key
trueWhether the token has a Freeze key
falseWhether the token has a KYC key
trueWhether the token has a Wipe key
trueUnauthorized request.
Forbidden
Internal server error.
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
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5Token identifier
69b8115f3dc0fa022156fb89Successful operation.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Hedera token ID
0.0.6046500Human-readable name of the token
Carbon Credit TokenShort ticker symbol for the token
CCTToken type on Hedera
fungiblePossible values: Number of decimal places
2Whether the current user is associated with this token
trueWhether the current user's account is frozen for this token
falseWhether the current user has passed KYC for this token
trueCurrent token balance for the user
1000.50Whether the token has an Admin key
trueWhether the token has a Freeze key
falseWhether the token has a KYC key
trueWhether the token has a Wipe key
trueUnauthorized request.
Forbidden
Internal server error.
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
}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.
Organization identifier
69aeb71ef8c5b278e3bab4e5Token identifier
69b8115f3dc0fa022156fb89Successful operation.
Internal database identifier
69aeb71ef8c5b278e3bab4e5Hedera token ID
0.0.6046500Human-readable name of the token
Carbon Credit TokenShort ticker symbol for the token
CCTToken type on Hedera
fungiblePossible values: Number of decimal places
2Whether the current user is associated with this token
trueWhether the current user's account is frozen for this token
falseWhether the current user has passed KYC for this token
trueCurrent token balance for the user
1000.50Whether the token has an Admin key
trueWhether the token has a Freeze key
falseWhether the token has a KYC key
trueWhether the token has a Wipe key
trueUnauthorized request.
Forbidden
Internal server error.
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 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).
Organization identifier
69aeb71ef8c5b278e3bab4e5Token identifier
69b8115f3dc0fa022156fb89Target Hedera account ID
0.0.12345Amount (FT) or serial count to pick (NFT); must be > 0
10Specific NFT serial numbers to transfer; positive integers
[1,2,3]Optional transaction memo
Successful operation.
No content
Unauthorized request.
Forbidden
Internal server error.
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