This guide will walk you through the steps to get the Institutional Vault's API Key and use it in the API reference documents.

Follow the steps below, and you'll be up and running with the Institutional Vault quickly!

1. Log In to the Institutional Vault

Navigate to the Institutional Vault here. Log in using your organization's identity provider here.

📘
Note:
If you have not signed up for the Institutional Vault account, please sign up here.

2. Onboarding the Institutional Vault

Set up your Institutional Vault environment by installing the Institutional Vault approver app from the iOS app store and setting up the wallet environment. Follow the steps listed here to onboard your Institutional Vault properly.

3. Get Wallet's API Key

You can get your Wallet's API Key by following the steps below:

Log in to Institutional Wallet App UI.
Go to Settings .

Click the API Keys section of the settings menu.

Click Create API Key on the top right side of your screen.

Specify the API Key's Name and User.

Click Create.

Approve the operation on your Institutional Vault Approver application.
This list will include the newly created API User and the API Key, which you can use to test the wallet's API reference.

📘
Note:
Ensure that your account is the API User's confirmer.

4. Try Calling the API

Let's try calling the Institutional Vault API from our API reference documentation:

Navigate to the API Reference > Select a specific endpoint you want to try.

Paste your API Key in the Authentication field as a Header.

Specify your Base Url in the URL field.

Specify the required path or query parameters.

Click on the "Try it" button.

Receive a Response.

5. Generate Client SDKs

For developers who want to integrate the Institutional Vault API into their applications, you can generate client SDKs in your preferred programming language using the OpenAPI specification.

Download the OpenAPI Specification

Access your wallet's API documentation by navigating to https://your-wallet-domain.com/swagger.html
Download the OpenAPI specification (openapi.yaml file) from the Swagger UI interface
Use the specification to generate client SDKs for your preferred language