Tasks

Background task tracking for long-running operations.

Returns task statuses by Id.

get

Returns task statuses by Id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

Responses

200

Successful operation.

application/json

actionstringRequired

Task type

Example: Create policy

userIdstringRequired

User Id

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

expectationnumberRequired

Expected count of task phases

Example: 0

taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

datestringRequired

Date

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

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get/tasks/{taskId}

GET /api/v1/tasks/{taskId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "action": "Create policy",
  "userId": "69aeb71ef8c5b278e3bab4e5",
  "expectation": 0,
  "taskId": "69aeb71ef8c5b278e3bab4e5",
  "date": "string",
  "statuses": [
    {
      "message": "string",
      "type": "Info"
    }
  ],
  "result": {},
  "error": {}
}

Returns task status of user onboarding by Id without authentication.

get

Returns task status of user onboarding by Id. No Bearer token required.

Path parameters

taskIdstringRequired

Task Id returned by the initiating endpoint

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

Responses

200

Successful operation.

application/json

actionstringRequired

Task type

Example: Create policy

userIdstringRequired

User Id

Example: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599

expectationnumberRequired

Expected count of task phases

Example: 0

taskIdstringRequired

Task Id

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

datestringRequired

Date

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

401

Task exists but is not an onboarding task.

application/json

500

Internal server error.

application/json

get/tasks/onboard/{taskId}

GET /api/v1/tasks/onboard/{taskId} HTTP/1.1
Accept: */*

{
  "action": "Create policy",
  "userId": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
  "expectation": 0,
  "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "date": "2026-03-03T17:25:53.312Z",
  "statuses": [
    {
      "message": "text",
      "type": "Info"
    }
  ],
  "result": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "error": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}