v0.2.6
OAS 3.1.0

Hovi API (Open ID)

The Hovi API allows developers to seamlessly integrate with the OpenID ecosystem, supporting the issuance and verification of SD-JWT and JSON-LD credentials via the OID4VC/VP protocol. This API documentation provides detailed guidance on each endpoint, empowering you to build and manage robust digital identity solutions.

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": "99f009f6-aefa-4c13-bbe9-e5e314a64b1c",
    "createdAt": "2024-08-08T06:40:20.151Z",
    "updatedAt": "2024-08-08T06:40:20.151Z",
    "setting": {
      "tenantName": "acme-corp",
      "webhooks": [],
      "defaultLabel": "acme-corp",
      "imageUrl": "https://acme-corp.com/acme-logo-color.png",
      "id": "99f009f6-aefa-4c13-bbe9-e5e314a64b1c"
    },
    "accessToken": "eyJhbGciOiJIUzI1NiJ9.ZXlKMFpXNWhiblJKWkNJNklqazVaakF3T1dZMkxXRmxabUV0TkdNeE15MWlZbVU1TFdVMVpUTXhOR0UyTkdJeFl5SXNJbWxoZENJNk1UY3lNekE1T1RJeU9IMD0.wpmj0C-Pcjsk-pg42_SPqMhCmKibdI6A6Kxq4gBG6hk",
    "dids": [
      {
        "did": "did:key:z6MkoMXChyU15xJkecBmhkbwiKXsUJ1qJR3QJdQDijp8is71",
        "method": "key",
        "seed": "KC7anZVWo2CiQDfcFXUvMDdWoerGc9L7"
      }
    ],
    "webhooks": [
      {
        "webhookId": "1733324555b130efaa81de966d779cd6",
        "webhookUrl": "https://webhook2.com",
        "tenantId": "99f009f6-aefa-4c13-bbe9-e5e314a64b1c"
      }
    ]
  }
}

Models