zkPass
zkPass User's Guide
zkPass User's Guide
  • Getting Started
    • πŸ”ŠIntroduction
      • What is zkPass?
      • How does it work?
      • How zkPass can help you
      • What's Ahead
    • 🌀️Service-based Proof System
      • Main Features
      • zkPass Workflows
      • Deployment Options
        • Public-Cloud Hosting
        • Private-Cloud Hosting
        • On-Premise Hosting
    • πŸ—οΈKey Concepts
      • User Data
      • DVR
      • zkPass Proof
  • Core Components
    • πŸ›οΈService Architecture
      • RESTful API Web Service
      • zkPass Query Host
    • πŸ‘₯zkPass Client Roles
    • 🀝Trust Models
      • Data Privacy Trust Model
      • Data Integrity Trust Model
      • Computation Integrity Trust Model
    • πŸ‘©β€πŸ’»zkPass Module
  • Use Cases
    • 🩸Employee Onboarding
      • β€œBlood Test Result” User Data
      • "Employee Onboarding" DVR
      • zkPass Integration
      • Call Sequence
    • 🚘Loan Application Screening
      • β€œBCA Customer Profile” User Data
      • Loan Screening DVR
      • zkPass Integration
      • Call Sequence
    • πŸ›’Sharing OIDC Users Securely
      • "ShopSphere ID Token" User Data
      • "ShopSphere Account Holder" DVR
      • zkPass Integration
        • Integration Guidelines for ShopSphere OIDC Provider
        • Integration Guidelines for Krisna Service
        • Integration Guideline for ShopSphere App
      • Call Sequence
  • FAQ
    • How is verifiable computing implemented by ZKP?
  • Glossary
    • Client-based Proof System
    • DVR
    • User Data
    • zkPass Proof
Powered by GitBook
On this page
Export as PDF
  1. Core Components
  2. Service Architecture

RESTful API Web Service

PreviousService ArchitectureNextzkPass Query Host

Last updated 1 year ago

Imagine you have a digital helper that can securely verify important information for you without ever needing to see the details – that's what the RESTful API web service component of zkPass Service is all about. It's like a trusted messenger that carries sealed envelopes (your and the ) to a secure vault (zkPass Query Host) and brings back a stamp of approval, all without peeking inside.

Here's how it works for you: Whenever you want to check if certain information is true or meets specific criteria, you don't need to handle the sensitive details yourself. Instead, you send a request to our web service RESTful API called generate_zkpass_proof. This request is like a special envelope containing a question you want to be answered, based on the data you're curious about.

The zkPass Query Host, the digital vault, then works its magic. It carefully examines your request, verifies the information against the criteria you've set, and sends back proof – a kind of digital stamp – that confirms whether the information meets your requirements. The best part? This all happens without the web service ever actually seeing or storing the sensitive data you're inquiring about.

πŸ›οΈ
user data
Data Verification Request