Hovi Documentation

website·Indexed 33 days ago

https://docs.hovi.id

Developer guides and API references for the Hovi platform, focusing on the issuance and verification of verifiable credentials. Includes documentation for the Business Wallet API, Hovi SDK, and Hovi Studio, with support for ecosystems such as EU Digital Identity, Polygon, Indicio, Cheqd, and Microsoft Entra.

Tokens
32.5K
Snippets
92
Records
263
Agent score
53%

What's inside Hovi

  1. Overview of Hovi Self-Sovereign Identity Platform

    Hovi is a platform that enables businesses to issue, verify, and manage verifiable credentials and zero-knowledge proofs using self-sovereign identity (SSI). It supports multiple identity ecosystems, including EU Digital Identity, Polygon, Cheqd, Indicio, and Microsoft Entra. The platform is designed to be multi-ecosystem to prevent vendor lock-in, supporting various DID methods and communication protocols.
  2. Overview of Hovi Cloud Wallet API

    The Cloud Wallet API is a managed wallet layer for the Holder role, allowing user-facing applications to store and present credentials without managing local wallet infrastructure or cryptographic keys. It supports multi-protocol interoperability (e.g., DIDComm, OpenID) and formats like SD-JWT, mDocs, and JSON-LD. Key capabilities include wallet provisioning (create, retrieve, recover), accepting/declining credential offers, submitting proof presentations, and managing secure connection channels via webhooks.
  3. Overview of Hovi Business Wallet API

    The Business Wallet API is designed for organizations acting as Issuers or Verifiers. It provides a scalable interface to manage the lifecycle of verifiable credentials across multiple identity ecosystems (such as EU Digital Identity, Cheqd, Indicio, and Polygon) and supports formats including SD-JWT, JSON-LD, and mDocs. Key capabilities include creating credential offers, managing issuance policies, validating proof presentations, and managing tenant-level settings and webhooks.
  4. Overview of Hovi Studio no-code platform

    Hovi Studio is a visual, web-based no-code platform designed for organizations to issue, verify, and manage digital credentials—such as certificates, licenses, badges, and verification documents—without requiring technical expertise or coding. It is suitable for HR managers, educational administrators, compliance officers, healthcare administrators, event organizers, and membership organizations.
  5. Overview of SDK Connection Management

    Connections in the Hovi Core SDK represent peer-to-peer relationships between organizations and other entities across multiple ecosystems, including EU Digital Identity, Microsoft Entra, Indicio, Cheqd, and Polygon. These connections are essential for enabling credential issuance and proof requests.
  6. Overview of Hovi Wallet capabilities

    Hovi Wallet is a digital identity wallet that allows users to manage, store, and verify verifiable credentials. It follows a self-sovereign identity (SSI) model, giving users full ownership and control over their credentials rather than relying on centralized systems or issuers. The wallet is compatible with all ecosystems supported by Hovi and works across various SSI networks to ensure interoperability.
  7. Overview of the Cloud Wallet SDK

    The Cloud Wallet SDK (@hovi/cloudwallet-sdk) is a high-level TypeScript client used to integrate Digital Credential wallet services. It abstracts protocol and network complexity, allowing developers to implement wallet, credential, proof, connection, and webhook operations without managing their own cryptographic keys or wallet infrastructure. It specifically represents the 'holder side' of the identity ecosystem, complementing the Core SDK (which handles issuer and governance operations).
  8. Overview of the Hovi Core SDK

    The Core SDK (@hovi/core-sdk) is used to build identity solutions at the ecosystem and tenant level. It allows developers to create, manage, and orchestrate workflows for credential issuance, verification, and trust relationships. It supports multiple ecosystems including EU Digital Identity, Indicio, Cheqd, and Polygon, and is designed for high-volume, compliance-heavy enterprise use cases (e.g., eIDAS 2.0, GDPR, and ISO 27001).
  9. Understand the Hovi SDK credential lifecycle

    The Hovi SDK uses Ecosystem Clients to abstract authentication, request formatting, and network-specific nuances. The general lifecycle for issuing and verifying credentials is as follows:

    1. Initialize Client: Instantiate an ecosystem-specific client (e.g., OpenIdEcosystem, CheqdEcosystem) with configuration.
    2. Configure Issuer: Use the client to create a Tenant, establishing the digital identity of the issuer.
    3. Establish Connection: For ecosystems like Cheqd, Indicio, or Polygon, use SDK helper methods to generate invitations and poll for completion.
    4. Offer Credential: The issuer sends a credential offer formatted for the chosen ecosystem.
    5. Receive Credential: The user accepts the offer via their wallet.
    6. Verify Credential: The issuer requests a proof, and the user shares the required data.
  10. Resolve an OpenID URI for a credential offer

    Use the resolveOpenIdUri method to retrieve metadata and details about a credential offer before accepting it. Ensure the credentialOfferUri is valid and matches the specified protocol.
    import { CloudWallet } from '@hovi/cloudwallet-sdk';
    
    const wallet = new CloudWallet({
      apiKey: 'your-ecosystem-api-key',
    });
    
    const result = await wallet.resolveOpenIdUri({
      protocol: 'openid',
      credentialOfferUri: 'https://example.com/credential-offer',
    });
  11. Understand Hovi Studio Connections

    Connections establish a secure, encrypted communication channel between an organization and another wallet (user or organization). This channel is required to issue verifiable credentials. Hovi Studio supports the following ecosystems and protocols:

    • Polygon: Uses Iden3
    • Indicio: Uses DIDComm protocol
    • Cheqd: Uses DIDComm protocol
  12. Understand Hovi identity ecosystem components

    The Hovi platform is built on several core components that enable interoperability across different identity networks:

    • Ecosystem: Identity networks that allow organizations to interact, issue, and verify digital credentials across various platforms and standards.
    • Credential Types: The defined structures and formats for digital credentials, tailored to specific use cases and compliance requirements.
    • Communication Protocols: The secure, encrypted channels used to exchange verifiable credentials between issuers, holders, and verifiers.
    • DID Methods: Decentralized Identifier (DID) methods that provide unique, self-owned identifiers to enable secure digital identities without centralized authorities.
    • Wallets: Support for multiple digital wallets, allowing users to manage credentials from various providers to avoid vendor lock-in.