Overview

Prerequisites

Before you get started with the zkPass API, here's what you'll need:

1. API Credentials

2. User Data Token

3. DVR Token

How to Access the API

The zkPass API uses a familiar approach called basic authentication to ensure secure access. Here's what you'll need:

• API Key: This unique identifier acts like your username for the API.

• API Secret Key: Consider this your password, but much more secure. Keep it confidential!

Register on the zkPass portal to obtain your API and secret keys.

Including Your Credentials:

To access the API, you'll need to provide both your API Key and API Secret Key in every request you make. They should be included in the authorization header of your requests.

Don't Have Credentials Yet?

No worries! If you haven't received your API credentials, simply fill out our easy-to-use form to request them. We'll get you set up in no time.

Utilities

Our utilities section provides a detailed guide on creating a key pair. This key pair is used for signing and encrypting your user data token (and DVR token, if needed). Here's a quick overview of the steps involved:

1. Generate Key Pair
2. Sign User Data and DVR
3. Encrypt User Data and DVR