v0.2.6
OAS 3.1.0

Hovi API (Cheqd)

The Hovi API provides comprehensive integration with the Cheqd ecosystem, allowing the issuance and verification of JSON-LD and AnonCreds credentials via Didcomm over the Cheqd network. This API documentation offers full endpoint details to assist in the creation and management of decentralized digital identities.

Hovi SaaS

None
Client Libraries

Tenants

Tenant endpoints allow the creation, deletion, and management of tenants in the Hovi ecosystem. Tenants are essential entities that handle the majority of operations, including creating credential templates, verification templates, issuing credentials, and initiating verification proof requests.

Create Tenant

This route allows for the creation of a new tenant within an ecosystem.

Body
application/json
tenantName
string
required
ExampleAcme Corp
tenantLabel
string
required
Exampleacme-corp
tenantSecret
string
required
Exampleacme-corp-secret
imageUrl
string
required
Examplehttps://acme-corp.com/logo.png
webhooks
array string[]
Example[ "https://acme-corp.com/webhook1", "https://acme-corp.com/webhook2" ]
Responses
POST/tenant/create

{
  "success": true,
  "response": {
    "tenantId": "668c8266-a026-4568-a3ed-fe0ad46fa87c",
    "createdAt": "2024-08-07T08:32:38.515Z",
    "updatedAt": "2024-08-07T08:32:38.515Z",
    "setting": {
      "tenantName": "acme-corp",
      "webhooks": [],
      "defaultLabel": "acme-corp",
      "imageUrl": "https://acme-corp.com/acme-logo-color.png",
      "id": "668c8266-a026-4568-a3ed-fe0ad46fa87c"
    },
    "accessToken": "eyJhbGciOiJIUzI1NiJ9.ZXlKMFpXNWhiblJKWkNJNklqWTJPR000TWpZMkxXRXdNall0TkRVMk9DMWhNMlZrTFdabE1HRmtORFptWVRnM1l5SXNJbWxoZENJNk1UY3lNekF4T1RVMk1uMD0.Bzxq8V2hv34T8YV1XSag6-hVRCuxQytv2aXX0dr7yKw",
    "dids": [
      {
        "did": "did:key:z6MkixGc9RdCEWbHaoNo4SoJ3Gs6tKZXuQVV5DNnJeG3EpgT",
        "method": "key",
        "seed": "KC7anZVWo2CiQDfcFXUvMDdWoerGc9L7"
      }
    ],
    "webhooks": [
      {
        "webhookId": "7605e2130d0d5390756b605dd72d951f",
        "webhookUrl": "https://webhook2.com",
        "tenantId": "668c8266-a026-4568-a3ed-fe0ad46fa87c"
      }
    ]
  }
}

Models