Getting Started

🚀 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:

---

🚀 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

Sign Up Page

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.

Email Verification

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 Login

Dashboard Overview

You can access your api key in the dashboard 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:

curl -X GET \
  "https://api.zeru.finance/zscore/wallet/0x742d35Cc6634C0532925a3b8D4C9db96590b5" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Expected Response

{
  "wallet_address": "0x742d35Cc6634C0532925a3b8D4C9db96590b5",
  "zscore": 750,
  "risk_level": "Low",
  "percentile": 85,
  "description": "Experienced DeFi user with strong lending history",
  "categories": {
    "defi": 780,
    "nft": 650,
    "gaming": 400
  },
  "last_updated": "2024-01-15T10:30:00Z",
  "proof": {
    "merkle_root": "0x1234567890abcdef...",
    "merkle_proof": ["0xabcd...", "0xefgh..."]
  }
}

Response Validation

Verify your response contains:

• ✅ Valid wallet address

• ✅ Numeric zScore (0-1000)

• ✅ Risk level classification

• ✅ Percentile ranking

• ✅ Merkle proof for verification

---

Error Handling

Implement robust error handling:

async function getZScore(walletAddress) {
  try {
    const response = await fetch(`https://api.zeru.finance/zscore/wallet/${walletAddress}`, {
      headers: {
        'Authorization': `Bearer ${process.env.ZPASS_API_KEY}`,
        'Content-Type': 'application/json'
      }
    });

    if (!response.ok) {
      throw new Error(`HTTP ${response.status}: ${response.statusText}`);
    }

    return await response.json();
  } catch (error) {
    console.error('zPass API Error:', error);
    // Implement fallback logic
    return { zscore: null, error: error.message };
  }
}

---

🆘 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

• 📚 Documentation: API Reference
• 💬 Discord: Real-time community support

• 📧 Email: [email protected]

• 🐛 Issues: Report bugs via Discord or email

---

🎯 Next Steps

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

1. API Reference - Complete endpoint documentation
2. Use Cases - Discover powerful applications

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