zScore Docs
  • Core
    • What is zScore
    • How It Works
    • Operational Mechanics
  • For Operators
    • Mainnet
      • Quickstart (Mainnet)
      • Registration (Mainnet)
  • For Protocols
    • Overview
    • zPass
      • Getting Started
      • API Reference
        • Get zScore by Wallet
        • Get Wallets zScore
        • Get Wallets by Protocol
        • Get Protocol Risk Clusters
        • Get wallet analytics by protocol
        • Get Global Protocol Analytics
Powered by GitBook
On this page
  • 🚀 Quick Start Guide
  • 🎯 Integration Overview
  • 🚀 Step 1: Create Your Developer Account
  • Visit the zPass Portal
  • What You'll Need
  • Account Types
  • 📧 Step 2: Email Verification
  • Check Your Inbox
  • Verification Process
  • Verification Timeline
  • 🔑 Step 3: Access Your Dashboard
  • Login to Your Account
  • Dashboard Overview
  • 🧪 Step 4: Make Your First API Call
  • Test Connection
  • Expected Response
  • Response Validation
  • 🆘 Troubleshooting
  • Common Issues
  • Getting Help
  • 🎯 Next Steps
  1. For Protocols
  2. zPass

Getting Started

PreviouszPassNextAPI Reference

Last updated 4 days ago

🚀 Quick Start Guide

Welcome to zPass! This guide will get you up and running with Web3's most comprehensive wallet intelligence platform in just a few minutes.


🎯 Integration Overview

zPass integration follows a simple 4-step process:

  • Sign Up Create your account at

  • Make Your First API Call Use the API Playground to test endpoints in seconds.

  • Get Your API Key Navigate to the API Analytics page and access your secure key.

  • Go Live Integrate the API into your app and start verifying wallets in production.


🚀 Step 1: Create Your Developer Account

Visit the zPass Portal

Navigate to our developer portal to begin your integration journey.

🌐 Portal URL: https://zpass.myzscore.ai

What You'll Need

  • Email Address: Your primary contact email

  • Secure Password: Use a strong, unique password

Account Types

Plan
Rate Limit
Features
Best For

Developer

1,000/month

Basic scoring

Testing & prototyping

Startup

10,000/month

Full analytics

Growing protocols

Enterprise

Custom

Custom models

Large-scale applications

💡 Tip: Start with the Developer plan for testing, then upgrade as you scale.


📧 Step 2: Email Verification

Check Your Inbox

After signing up, check your email for a verification message.

Verification Process

  1. Check Primary Inbox: Look for email from [email protected]

  2. Click Verification Link: Click the secure verification link

  3. Confirm Activation: You'll see a success message

Verification Timeline

  • Instant: Most verifications complete immediately

🔄 Didn't receive email?

  • Contact support if issues persist


🔑 Step 3: Access Your Dashboard

Login to Your Account

Once verified, log in to access your developer dashboard.

Dashboard Overview

You can access your api key in the API Analytics page, generated automatically

Your dashboard provides:

📊 Usage Analytics

  • API call volume and trends

  • Performance metrics

📚 API Playground

  • Interactive API explorer

  • Integration Code examples

🎯 Wallets Explorer

  • Search and find wallets and wallet insights


🧪 Step 4: Make Your First API Call

Test Connection

Verify your integration with a simple API call:

Expected Response

{
  "wallet_address": "0x0598df9ef51616e9c015a4f17918507259b22baf",​
  "score": "50000000000000000000",​
  "proof": [​"0x1234567890abcdef..."]
  }
}

Response Validation

Verify your response contains:

  • ✅ Valid wallet address

  • ✅ Numeric zScore (0-1000)

  • ✅ Merkle proof for verification


🆘 Troubleshooting

Common Issues

401 Unauthorized

  • Check your API key is correct

  • Ensure key hasn't expired

  • Verify proper Authorization header format

429 Rate Limited

  • Implement exponential backoff

  • Check your rate limits in dashboard

  • Consider upgrading your plan

Invalid Wallet Address

  • Ensure address is properly formatted

  • Check address is a valid Ethereum address

  • Verify checksum if using mixed case

Getting Help

  • 💬 Discord: Dev community support

  • 📧 Email: [email protected]

  • 🐛 Issues: Report bugs via Discord or email


🎯 Next Steps

Now that you're set up, explore advanced features:

Ready to build something amazing? Your Web3 intelligence journey starts now! 🚀

📚 Documentation:

- Complete endpoint documentation

https://zpass.myzscore.ai
API Reference
API Reference
Sign Up Page
Email Verification
Dashboard Login