zkMe Dochub
GitHubTwitterDiscord
  • zkMe Network
  • Learn about zkMe Network
    • Introduction
    • Try a Demo
    • High Level Architectural Overview
      • High Level User Stories
      • zkMe Protocol Components
        • zkMe zkVault
        • zkMe DID Method
        • zkMe Credential Suites
        • zkMe Self-Sovereign Identity
    • Vision, Mission & Design Philosophy
    • Value Propositions & Use Cases
  • Verify with zkMe Protocol
    • Integration Checklist
      • zkMe Dashboard Setup
      • zkMe Supported Chains Overview
      • zkMe Protocol Smart Contract
    • Integration Guide
      • JavaScript SDK
        • zkKYC - Compliance Suite
        • MeID - Anti-Sybil Suite
        • Me - Profiling Suite
      • zkMe API
        • zkKYC - Compliance Suite
          • Verify zkKYC Status
          • Get KYT Results
      • Platform Integration
        • QuestN Integration
      • Smart Contract Verification
        • Compliance Suite
      • Customize Widget UI
    • zkKYC - Compliance Suite
      • zkMe zkKYC Levels
      • Regulatory Frameworks
        • EU - MiCA/TFR Regulations
        • US - Crypto Regulations
        • UK - Crypto Regulations
      • zkKYC Credentials
        • Proof-of-Citizenship (zkPoC)
        • Proof-of-Location (zkPoL)
        • Proof-of-Accredited-Investor (zkPoAI)
        • AML Check (AMLMe)
        • Know Your Transaction (KYT)
          • KYT Supported Scope
        • Know Your Business (KYB)
    • MeID - Anti-Sybil Suite
      • CKKS Homomorphic Encryption
      • DID Creation
      • MeID Credentials
        • MeID
    • Me - Profiling Suite
      • MeScores Credentials
        • zkCredit Score
        • zkSocial Network
        • zkDAO Management
        • zkGaming Status
    • zkMe Roadmap
  • Explore More
    • zkMe Bug Bounty Program
    • zkMe Brand Kit
    • zkMe Identity Hub
    • FAQ
    • Glossary
    • Link
      • GitHub
      • X / Twitter
      • Medium
      • YouTube
      • LinkedIn
      • Discord
      • Blog
    • Privacy Policy
Powered by GitBook
On this page
  • OpenAPI Domain
  • Authentication
  • Common Response Data Structure
  • Rate Limits
  1. Verify with zkMe Protocol
  2. Integration Guide

zkMe API

The section describes the zkMe OpenAPI, which is also known as zkMe API. It focuses on KYC (Know Your Customer) and KYT (Know Your Transaction) services.

PreviousMe - Profiling SuiteNextzkKYC - Compliance Suite

Last updated 2 months ago

OpenAPI Domain

Authentication

  • mch_no: Your AppID.

  • api_key: Your API Key.

You can get your mch_no and api_key from . You can pass the mch_no and api_key either through URL query parameters or in the request header. For example:

curl https://openapi.zk.me?api_key=xxx&mch_no=xxx
curl -H "api_key: xxx" -H "mch_no: xxx" https://openapi.zk.me

Common Response Data Structure

{
  "code": 200,
  "message": "success",
  "data": {}
}
Field
Type
Description

code

int

200: success, other: error

message

string

error message

data

object

response data

Rate Limits

Plan
Rate Limit

Standard

10 call / second / key

https://openapi.zk.me
zkMe Dashboard