New Release
Guardian 3.7.0
Ctrlk
Release NotesCalendar
youtube
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Relayer Accounts

Hedera relayer account configuration and management.

Returns the list of Relayer Accounts of the active user.

get

Returns the list of Relayer Accounts owned by the currently authenticated user. Supports pagination and text search by account name or Hedera account ID.

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

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

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
searchstringOptional

Filter by account name or Hedera account ID (case-insensitive, partial match). Leave empty to return all.

Responses
200

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

application/json
get/relayer-accounts
GET /api/v1/relayer-accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-25T15:30:37.191Z",
    "updateDate": "2026-03-25T15:30:37.191Z",
    "name": "New Test Account",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "account": "0.0.6046500",
    "username": "ExampleUser",
    "_id": "69c3ff9de85d8b6ef99ef86a",
    "id": "69c3ff9de85d8b6ef99ef86a"
  }
]

Adds a new Relayer Account for the active user.

post

Creates a new Relayer Account by associating an existing Hedera account (account ID + private key) with the current user. The key is stored securely in the wallet.

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

Human-readable name for the new relayer account

Example: My Relayer Account
accountstringOptional

Hedera account ID to use as relayer

Example: 0.0.6046379
keystringOptional

Private key for the Hedera account (stored securely in wallet)

Responses
200

Successful operation. Returns the created relayer account.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
namestringOptional

Human-readable name of the relayer account

Example: New Test Account
usernamestringOptional

Username of the relayer account owner

Example: ExampleUser
ownerstringOptional

DID of the relayer account owner

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
parentstring · nullableOptional

DID of the parent Standard Registry (for child users)

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

Hedera account ID of the relayer

Example: 0.0.6046379
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/relayer-accounts
POST /api/v1/relayer-accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "name": "My Relayer Account",
  "account": "0.0.6046500",
  "key": "302e020100300506032b657004220420..."
}
{
  "createDate": "2026-03-25T15:30:37.191Z",
  "updateDate": "2026-03-25T15:30:37.191Z",
  "name": "New Test Account",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "account": "0.0.6046500",
  "username": "ExampleUser",
  "_id": "69c3ff9de85d8b6ef99ef86a",
  "id": "69c3ff9de85d8b6ef99ef86a"
}

Returns current (default) Relayer Account of the active user.

get

Returns the default Hedera account of the active user, which is used as the relayer when no specific relayer account is selected.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful operation. Returns the default account info (name is always "Default").

application/json
namestringOptional

Account name (always "Default")

Example: Default
ownerstringOptional

Owner DID

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

Hedera account ID

Example: 0.0.6046379
get/relayer-accounts/current
GET /api/v1/relayer-accounts/current HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "Default",
  "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "account": "0.0.6046379"
}

Returns the list of Relayer Accounts available for use in the Policy by the active user.

get

Returns all Relayer Accounts owned by the current user. Unlike GET /, this endpoint returns all accounts without pagination.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful operation.

application/json
idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5
namestringOptional

Human-readable name of the relayer account

Example: New Test Account
usernamestringOptional

Username of the relayer account owner

Example: ExampleUser
ownerstringOptional

DID of the relayer account owner

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
parentstring · nullableOptional

DID of the parent Standard Registry (for child users)

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

Hedera account ID of the relayer

Example: 0.0.6046379
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/relayer-accounts/all
GET /api/v1/relayer-accounts/all HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-25T15:30:37.191Z",
    "updateDate": "2026-03-25T15:30:37.191Z",
    "name": "New Test Account",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "account": "0.0.6046500",
    "username": "ExampleUser",
    "_id": "69c3ff9de85d8b6ef99ef86a",
    "id": "69c3ff9de85d8b6ef99ef86a"
  }
]

Returns current HBAR balance of the specified Relayer Account.

get

Queries the Hedera network for the current HBAR balance of the specified account. The account must belong to the current user or be a relayer account owned by them.

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

Hedera account ID of the relayer account

Example: 0.0.6046379
Responses
200

Successful operation. Returns the HBAR balance as a string (e.g. "999.34 tℏ").

application/json
stringOptional
get/relayer-accounts/{account}/balance
GET /api/v1/relayer-accounts/{account}/balance HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

999.33977375 tℏ

Generate a new Relayer Account.

post

Generates a new Hedera account on the network and registers it as a Relayer Account for the current user. The account is created and funded automatically.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful operation. Returns the generated Hedera account ID and private key. Store the key securely — it is only returned once.

application/json
idstringOptional

Generated Hedera account ID

keystringOptional

Private key for the generated account (hex-encoded DER)

post/relayer-accounts/generate
POST /api/v1/relayer-accounts/generate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "0.0.8384973",
  "key": "302e020100300506032b6570042204202f750d1cbc05a26d8e9abb556f7be9f03e552f2d76d621639633491548434352"
}

Return the list of Relayer Accounts for the user.

get

If the active user is a Standard Registry, returns the list of all users (and their relayer accounts) under this SR. Each user appears once per relayer account plus once for the default account (with null relayer fields).

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

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

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
searchstringOptional

Filter by username, Hedera account ID, relayer account ID or name (case-insensitive, partial match)

Responses
200

Successful operation. Returns users with their relayer accounts and total count in X-Total-Count header.

application/json
get/relayer-accounts/accounts
GET /api/v1/relayer-accounts/accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "69aeb71ef8c5b278e3bab4e5",
    "username": "ExampleUser",
    "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "hederaAccountId": "0.0.6046379"
  },
  {
    "_id": "69aeb71ef8c5b278e3bab4e5",
    "username": "ExampleUser",
    "did": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "hederaAccountId": "0.0.6046379",
    "relayerAccountId": "0.0.6046500",
    "relayerAccountName": "New Test Account"
  }
]

Return the list of VC documents associated with the selected Relayer Account.

get

Returns paginated VC documents that were created using the specified relayer account. Each document is enriched with policyName, policyVersion, and schemaName.

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

Hedera account ID of the Relayer Account (not the database ID)

Example: 0.0.6046500
Query parameters
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 VC documents and total count in X-Total-Count header.

application/json
get/relayer-accounts/{relayerAccountId}/relationships
GET /api/v1/relayer-accounts/{relayerAccountId}/relationships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-13T09:26:55.610Z",
    "updateDate": "2026-03-13T09:27:09.653Z",
    "hash": "74RwXshVfxSkWFkNhDWdHHMqHhAFMbZ6pR4sepB4pJz2",
    "hederaStatus": "ISSUE",
    "signature": 0,
    "type": "STANDARD_REGISTRY",
    "option": {
      "status": "NEW"
    },
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.8200599",
    "messageId": "1773394029.513409000",
    "document": {
      "id": "urn:uuid:962aa166-7da1-4fab-ad88-6681ac55f770",
      "type": [
        "VerifiableCredential"
      ],
      "issuer": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "issuanceDate": "2026-03-13T09:26:55.502Z",
      "@context": [
        "https://www.w3.org/2018/credentials/v1",
        "ipfs://bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i"
      ],
      "credentialSubject": [
        {
          "OrganizationName": "Organization name",
          "Website": "https://google.com",
          "Tags": "Tag",
          "@context": [
            "ipfs://bafkreihj7gclc4qgem27tre5je6a3t7tpdrk4li6oamdl6bnflwnoyfs5i"
          ],
          "id": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
          "type": "StandardRegistry"
        }
      ],
      "proof": {
        "type": "Ed25519Signature2018",
        "created": "2026-03-13T09:26:55Z",
        "verificationMethod": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599#did-root-key",
        "proofPurpose": "assertionMethod",
        "jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..Uc6RaUnv_zC4xc9j3mBqdd8Ew3z6lZITofdoJUYpxDot-fZhQEtiDjPAj5Au6UwApAfTnXy_el-uv5iOdzOyCg"
      }
    },
    "documentFileId": "69b3d86d0b1c848021821bf9",
    "tableFileIds": [],
    "id": "69b3d85f0b1c848021821bf2"
  }
]
PreviousContracts
NextDMRV

Last updated

Was this helpful?