Skip to main content

Quick Start

This guide will walk you through the steps to get started with Hovi Studio and APIs. You’ll learn how to retrieve your API key, issue your first credential, receive it, and verify it using Hovi.

1. Get Your API Key​

Before interacting with Hovi APIs, you need to retrieve an API key to authenticate your requests.

Step 1: Register for a Hovi Studio Account​

  1. Visit Hovi Studio.

  2. Click "Get started" to access the sign-up page.

  3. Fill in the required details and click "Create account" to complete the registration process.

Step 2: Complete the Onboarding Process​

  1. Sign in using your registered credentials.

  2. Create your first ecosystem by providing a "Name" and an optional "Description".

  3. Select a network for your ecosystem from the available options.

  4. Choose the environment for your ecosystem.

  5. Select your subscription plan and click "Finish".

Once the onboarding is complete, you’ll be directed to the Hovi Studio dashboard.

Step 3: Retrieve Your API Key​

  1. Click on the "API Keys" tab from the left-hand navigation menu.

  2. Your pre-generated API key will be available under the "Active API Keys" section.

You can now use this key to authenticate your API requests.

2. Issue Your First Credential​

Follow these steps to issue a verifiable credential using Hovi.

Step 1: Log in to Hovi Studio​

  1. Use your registered credentials to sign in to Hovi Studio.

Step 2: Create a Tenant​

  1. In the dashboard, click on the "Tenants" tab.

  2. Click the "Create Tenant" button located at the top-right corner.

  3. Fill in the required details and click "Create Tenant" to create a new tenant.

  4. Your seed tenant's secret and DID seed phrases will be generated. Copy or download them, as they won’t be displayed again.

Your new tenant has been created.

Step 3: Create an Issuance Template​

  1. Navigate to the "Credential Templates" tab.

  2. Click the "Create Template" **button located at the top-right corner.

  3. Fill in the required details and click "Create Template" to create a new issuance template.

Your issuance template is now ready for use.

Step 4: Use API-Key to Issue a Credential​

Use the API key you generated earlier to issue a credential using Hovi’s API.

  1. Visit the Hovi API Reference.

  2. Navigate to your ecosystem's POST - Offer Credentials endpoint and click “Test Request”.

  3. Enter the API key as a Bearer Token, provide the body parameters, and click “Send”. The credential will be issued to the recipient/holder.

3. Receive Your First Credential​

Once the credential is issued:

  1. The holder will scan the QR code using their digital wallet (e.g., Hovi Wallet or compatible wallet) and receive the credential.
note

To see the complete list of supported wallets, please refer here: Supported Wallets List.

They can now securely store the credentials or share them with third-party verifiers as needed.

4. Verify Your First Credential​

Follow these steps to verify a credential using Hovi Studio and APIs.

Step 1: Log in to Hovi Studio​

  1. Sign in to your Hovi Studio account.

Step 2: Create a Tenant​

  1. If you don’t already have one, follow the same steps from earlier to create a tenant for verification.

Step 3: Create a Verification Template​

  1. Navigate to the “Verification Template” tab.

  2. Click the “Create Template” button at the top right corner.

  3. Fill in the required information and click “Create Template” to create a new verification template.

Step 4: Use API-Key to Verify a Credential​

Follow these steps to verify a credential using Hovi APIs.

  1. Visit the Hovi API Reference.

  2. Navigate to your ecosystem's POST - Send Proof Request endpoint and click “Test Request”.

  3. Enter your API key as a Bearer Token, fill in the body parameters, and click “Send".

  4. The verificationURL will lead you to a QR code that the recipient can scan using their digital wallet to accept the verification request.

  5. To check the verification status, you can use the GET - Get Proof Requests endpoint to check if the holder has accepted the verification request or not.

    pending state indicates that the holder has yet to accept the verification request.

  6. Once the holder scans the QR code, the credentials will be verified successfully, and the state will change to done.

Contents