zkPass
zkPass Developer's Guide
zkPass Developer's Guide
  • â›Šī¸Introduction
  • ZKPASS OVERVIEW
    • đŸ›ī¸Architecture
    • 🧱zkPass Components
    • 🤝Trust Models
    • 🚚Deployment
      • Public-Cloud Hosting
      • Private-Cloud Hosting
      • On-Premise Hosting
    • đŸŽ¯SDK Objectives
    • 🔑API Key
  • zkPass Modules
    • â˜ī¸DVR
      • đŸ—ģHigh Level View
      • đŸ—ī¸Key Concepts
        • User Data
        • DVR Info
        • zkPass Proof
      • đŸ‘ĨDVR Client Roles
        • Data Issuer
          • Providing User Data Retrieval API
        • Data Holder
          • 1. Retrieving the DVR
          • 2. Retrieving the User Data
          • 3. Generating the Proof
          • 4. Verifying the Proof
        • Proof Verifier
          • 1. Providing DVR Retrieval API
          • 2. Providing Proof Verification API
      • 🔎DVR Query
        • Building Query Engine
        • Processing Query
        • Query Grammar
      • đŸ—ī¸Integration Guidelines
      • 🌊DVR Workflows
  • SDK Tutorial
    • Typescript
      • Running Code
      • Code Snippet
      • Directory Structure
    • Rust
      • Running Code
      • Code Snippet
      • Directory Structure
  • API Reference
    • Typescript
      • Classes
        • Class: DvrModuleClient
      • Functions
        • Functions: ffiHelper
        • Functions: jwtHelper
        • Functions: publicKeyOptionUtils
      • Type Aliases
        • Types
        • Types: ffiType
      • Interfaces
        • Interfaces
      • Constants
        • Constants
        • Enums
      • Errors
    • Rust
      • Building Rust doc
    • RESTful API
      • Overview
      • Endpoints
        • Generate Proof
      • Utilities
        • Generate Key Pair
        • Sign User Data and DVR
        • Encrypt User Data and DVR
      • Errors
  • Glossary
    • DVR
    • User Data
    • ZKP
Powered by GitBook
On this page
  • Prerequisites
  • Generating Encrypted Tokens:
  • Endpoint
  • Request Header
  • Request Body
  • Response
Export as PDF
  1. API Reference
  2. RESTful API
  3. Endpoints

Generate Proof

PreviousEndpointsNextUtilities

Last updated 5 months ago

Prerequisites

Before using the Generating Proof Endpoint, There are three essential items you'll need to use the endpoint:

  1. encryptedUserDataToken : This token contains your encrypted user data

  2. encryptedDvrToken : This token holds your encrypted DVR data

  3. apiToken : This unique identifier authenticates your requests with the zkPass API

apiToken is the base64 form of YOUR_API_KEY:YOUR_API_SECRET.

Generating Encrypted Tokens:

For instructions on creating the encryptedUserDataToken and encryptedDvrToken, refer to our section. It provides a step-by-step guide that covers:

  1. : This creates the keys you'll use for signing your data.

  2. : This step adds a digital signature to your data tokens, ensuring their authenticity.

  3. : This encrypts your data tokens, making them unreadable by anyone without the decryption key.

Endpoint

Type
Value

HTTP Method

POST

API endpoint (Playground)

https://playground-zkpass.ssi.id/api/1.0/dvr/1.0/proof

Request Header

Authorization: Basic [apiToken]
Content-Type: application/json
Parameter
Description

Authorization

base64 form of YOUR_API_KEY:YOUR_API_SECRET

Content-Type

Indicates that the content being sent or received is JSON data

Request Body

{
    "user_data_token": "[encryptedUserDataToken]",
    "dvr_token": "[encryptedDvrToken]"
}
Parameter
Type
Mandatory
Description

user_data_token

string

Mandatory

encrypted user data token in JWE format

dvr_token

string

Mandatory

encrypted dvr token in JWE format

Response

{
    "status": 200,
    "proof": "eyJ0e..."
}

Please see example of encrypted User Data and DVR .

Utilities
Generating a Key Pair
Signing User Data and DVR
Encrypting User Data and DVR
here