New: MLM Software Documentation v2.5 — Updated API Reference & Commission Engine Guides. View API Docs

Platform Documentation v2.5 — Updated January 2025

MLM Software Documentation —
Complete Platform Guide
& API Reference

The official Global MLM Software documentation — your complete resource for platform setup, compensation plan configuration, commission engine rules, genealogy tree management, replicated website customization, e-wallet payouts, REST API reference, compliance tools, and integrations.

13 Doc Sections
Full API Reference
Code Examples
Always Updated
24/7 Support
Platform Modules — Documentation Status v2.5 Live
Getting Started Guide Updated
Commission Engine Updated
Genealogy Tree Updated
REST API Reference Updated
Integrations & Webhooks Updated
13
Doc Sections
50+
API Endpoints
v2.5
Latest
REST API Commission Genealogy E-Wallet Compliance Integrations
13+
Documentation Sections
50+
API Endpoints Documented
12+
Years of MLM Expertise
99.9%
Platform Uptime SLA
24/7
Technical Support Available

Getting Started with Global MLM Software

Everything you need to go from contract signing to a live MLM platform in 48–72 hours.

Welcome to the Global MLM Software documentation. This guide covers the complete platform from initial setup to advanced API integrations. Whether you are an MLM company owner configuring your first compensation plan, a developer building on the REST API, or a system administrator managing compliance tools, this documentation is your definitive reference.

Standard Deployment: Binary and Unilevel plans go live in 48–72 hours. Custom plans with unique compensation structures take 4–8 weeks. Your implementation manager will guide you through every step.

Deployment Steps

  1. Sign Contract & Make Payment — Your account is provisioned within 2 business hours of payment confirmation. You receive Admin Panel access credentials via email.

  2. Initial Configuration Call — Our implementation team schedules a 2-hour onboarding call to understand your compensation plan, product catalogue, rank structure, and branding requirements.

  3. Plan Configuration — Our team configures your compensation plan in the Admin Panel, sets up rank titles and qualifiers, and configures commission rules based on your plan document.

  4. Product Catalogue Setup — Upload your products via CSV import or the Admin Panel UI. Set prices, assign commission values per product/SKU, and configure inventory management.

  5. Website & Branding — Customize your company website template, upload logo, set brand colors, configure replicated website template for distributors, and set up domain mapping.

  6. Payment Gateway Integration — Connect your payment gateway (Stripe, PayPal, Razorpay, or others) for product purchases and distributor enrollment fees.

  7. User Acceptance Testing — Test the complete flow: distributor registration, product purchase, commission calculation, genealogy tree visualization, and payout processing.

  8. Go-Live & Launch — Platform goes live. Your implementation manager remains on call for 30 days post-launch (Standard plan) or 90 days (Enterprise plan).

Admin Panel Access: Log in at your-domain.com/admin using the credentials sent to your registered email. Enable two-factor authentication on first login.
Admin Panel
Full platform control: distributors, commissions, products, reports, settings, integrations.
Distributor Dashboard
Personal dashboard with commission history, genealogy, rank progress, and tools.
Mobile App
White-label iOS & Android app with real-time notifications and distributor tools.
Developer API
Full REST API for custom integrations, reporting, and third-party connections.
Replicated Sites
Branded distributor websites with product catalogue, registration forms & blog.
Analytics
50+ reports: recruitment, volume, commissions, rank advancement & retention.

Binary Plan Setup v2.5

Configure your two-leg Binary compensation plan with matching bonuses, capping rules, and cycle settings.

The Binary plan is configured in Admin Panel → Compensation Plan → Binary Settings. Your implementation team will handle the initial configuration; this guide covers ongoing adjustments and understanding the available settings.

Key Configuration Parameters

  • Pair Ratio: Set 1:1 (balanced) or configure a non-balanced ratio (e.g., 2:1 left-heavy)
  • Pair Value: Commission earned per qualifying pair (e.g., ₹500 or $10 per pair)
  • Daily Cap: Maximum pairs per day per distributor position
  • Carry-Forward: Enable/disable unmatched volume carry-forward to next cycle
  • Matching Bonus: Percentage of direct referrals' commissions paid to sponsor (e.g., 10%)
  • Direct Referral Bonus: One-time bonus for each personal sponsor (e.g., ₹200 / $5)
Important: Changing binary capping rules mid-cycle will take effect from the next commission cycle start date. Retroactive changes require a support ticket for data integrity review.

Admin Panel Path

PATH Admin PanelCompensation PlanBinary SettingsPair Settings → Ratio, Pair Value, Daily Cap ↳ Carry Forward → Enable/Disable, Max carry-forward days ↳ Bonus Types → Direct Bonus, Matching Bonus, Fast Start ↳ Rank Qualifiers → Volume requirements per rank ↳ Cycle Settings → Weekly / Bi-Weekly / Monthly payout cycle

Sample Binary Commission Config (JSON)

JSON { "plan_type": "binary", "pair_ratio": "1:1", "pair_value": { "amount": 500, "currency": "INR" }, "daily_cap_pairs": 50, "carry_forward": true, "carry_forward_days": 7, "direct_referral_bonus": { "amount": 200, "currency": "INR" }, "matching_bonus_pct": 10, "cycle": "weekly", "payout_day": "monday" }

Commission Engine v2.5

Configure real-time commission calculations, bonus types, capping rules, and payout cycles for any plan.

The Global MLM Software Commission Engine runs in real-time by default, calculating and crediting commissions instantly on qualifying events (purchases, enrollments, rank advancements). It supports all major plan types — Binary, Unilevel, Matrix, Generation, Stairstep Breakaway — with configurable bonus types, capping rules, and cycle-based payout processing.

Supported Bonus Types

  • Direct / Referral Bonus — One-time commission on personal sponsor's first purchase or enrollment
  • Level Commission — Percentage of downline sales volume by level (Unilevel, Matrix)
  • Matching Bonus — % of direct referrals' commissions (Binary)
  • Pair / Cycle Bonus — Commission per qualifying pair in Binary cycle
  • Leadership / Override — % of qualified downline group volume (Generation, Stairstep)
  • Rank Advancement Bonus — One-time cash bonus on reaching a new rank
  • Fast Start Bonus — Higher commission rate in first 30/60/90 days post-enrollment
  • Pooled / Global Bonus — % of company-wide volume distributed to qualifying leaders
  • Lifestyle Bonus — Monthly car/house allowance for top-ranked distributors

Commission Calculation Flow

FLOW // Commission Engine — Real-Time Processing Flow 1. Qualifying Event → (Purchase | Enrollment | Rank Advance) 2. Event Validator → Check qualification rules (PV, GV, Active status) 3. Upline Traversal → Walk genealogy tree (Binary: 2 legs | Unilevel: N levels) 4. Bonus Calculator → Apply bonus type rules per ancestor node 5. Cap Checker → Verify daily/cycle caps not exceeded 6. E-Wallet Credit → Instant credit to distributor e-wallet 7. Notification → Push + Email notification to distributor 8. Audit Log → Immutable record written to audit trail
Processing Mode: Real-time mode is the default. High-volume companies (50,000+ distributors) can switch to batch processing (every 15 minutes) via Admin Panel → Commission Engine → Processing Mode.

Genealogy Tree v2.5

Manage, visualize, and navigate your distributor genealogy tree with search, filtering, and performance overlays.

The Genealogy Tree module provides an interactive, drill-down visualization of your entire distributor network — from your company root to the deepest downline levels. Accessible from both the Admin Panel and individual distributor dashboards, the tree supports search, rank filtering, volume overlays, and export functionality.

Tree Visualization Features

  • Drill down to 10+ levels with smooth pan & zoom
  • Search by distributor name, ID, email, or phone number
  • Filter by rank, active status, joining date range, or volume range
  • Volume overlay — view Personal Volume (PV) and Group Volume (GV) on each node
  • Rank badge color-coding for instant visual identification
  • Export subtree as PDF or Excel for reporting
  • Binary leg balance indicator — real-time left/right leg volume comparison
  • Mobile-responsive tree view in distributor app

Admin Panel — Tree Management

PATH Admin PanelGenealogyTree ViewSearch → ID / Name / Email / Phone ↳ Filter → Rank / Status / Volume / Date ↳ Placement → Manual override (Admin only) ↳ Reports → Subtree export (PDF / Excel / CSV) ↳ Leg Viewer → Binary left/right balance (Binary plan only) ↳ Depth Report → Level-by-level count & volume summary

Replicated Websites v2.5

Configure, customize, and manage personalized distributor replicated websites across your network.

Every distributor in your network automatically receives a branded replicated website — a personalized copy of your company's main website featuring their profile, sponsor link, product catalogue, enrollment form, and blog. Replicated websites are SEO-optimized, mobile-responsive, and fully customizable through the Admin Panel.

Replicated Website URL Structure

URL FORMAT // Default replicated website URL formats: https://your-domain.com/ref/distributor-id https://your-domain.com/ref/distributor-username // Custom subdomain (requires DNS setup): https://john-smith.your-domain.com // Custom domain mapping (Enterprise plan): https://john-custom-domain.com

Template Customization Options

  • Logo, brand colors, and font selection per template
  • Homepage banner, hero image, and call-to-action text
  • Product catalogue display — grid or list layout, filtering options
  • Distributor profile section — photo, bio, contact details, social links
  • SEO settings per distributor — meta title, description, focus keyword
  • Blog / content section with distributor-specific posts
  • Lead capture form — connected to CRM and distributor's dashboard
  • Google Analytics tracking code injection
Template Access: Admin Panel → Replicated Websites → Templates. Changes to the master template apply to all distributor sites instantly. Individual distributors can customize their profile section and bio from their distributor dashboard.

E-Wallet & Payouts v2.5

Configure e-wallet balances, withdrawal limits, payout methods, and payment gateway integrations.

The E-Wallet module holds all earned commissions, bonuses, and refunds for each distributor. Distributors can request withdrawals to their bank account, UPI, PayPal, or crypto wallet (if enabled) through their dashboard. Admin can process payouts manually or configure automatic payout schedules.

Supported Payout Methods

  • Bank Transfer (NEFT / RTGS / IMPS / SWIFT / SEPA / ACH)
  • UPI (India) — instant settlement
  • PayPal — international payouts
  • Stripe Payouts — 135+ currencies
  • Payoneer — global mass payouts
  • Crypto Wallet (USDT, BTC, ETH — optional module)
  • Check / Cheque — physical cheque processing (USA/UK)

Payout Configuration

PATH Admin PanelE-WalletPayout SettingsMinimum Withdrawal → Set minimum amount (e.g., ₹500 / $10) ↳ Maximum Withdrawal → Daily/weekly/monthly limit per distributor ↳ Processing Schedule → Manual / Auto (Daily / Weekly / Monthly) ↳ TDS / Tax Deduction → Configure tax deduction percentage ↳ Service Charge → Platform withdrawal fee (flat / percentage) ↳ KYC Gate → Require KYC approval before first withdrawal
KYC Requirement: We strongly recommend enabling the KYC Gate for all payout methods to comply with anti-money laundering regulations. Distributors must submit government ID and bank details before their first withdrawal is processed.

REST API Reference v2.5

Complete REST API documentation with authentication, endpoints, request/response examples, and error codes.

The Global MLM Software REST API provides programmatic access to all platform data and functions. Use it to build custom dashboards, integrate with ERP systems, pull commission reports, manage distributors, and receive real-time events via webhooks.

Authentication

HTTP HEADER // All API requests must include Bearer token in Authorization header Authorization: Bearer YOUR_API_TOKEN Content-Type: application/json X-MLM-Version: 2.5 // Obtain API token: Admin Panel → Settings → API Keys → Generate Token // Tokens expire in 90 days. Rotate via Admin Panel or POST /api/auth/refresh

Core API Endpoints

Method Endpoint Description
GET /api/v2/distributors List all distributors with pagination & filters
GET /api/v2/distributors/:id Get single distributor profile by ID
POST /api/v2/distributors Create new distributor (manual enrollment)
PUT /api/v2/distributors/:id Update distributor profile data
GET /api/v2/commissions List commission transactions with date range filter
GET /api/v2/commissions/:dist_id Get commission history for specific distributor
GET /api/v2/genealogy/:dist_id Get downline tree for distributor (depth param)
GET /api/v2/ranks List all ranks with volume qualifiers
GET /api/v2/products List product catalogue with pricing & commission
POST /api/v2/orders Create order & trigger commission calculation
GET /api/v2/ewallet/:dist_id Get e-wallet balance & transaction history
POST /api/v2/ewallet/payout Initiate payout for distributor
GET /api/v2/analytics/summary Get platform summary stats (distributors, volume, commissions)
POST /api/v2/webhooks Register a webhook URL for event notifications
DELETE /api/v2/webhooks/:id Remove a registered webhook endpoint

Sample API Request — Get Distributor

cURL curl -X GET \ https://api.global-mlm.com/api/v2/distributors/dist_001234 \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -H "X-MLM-Version: 2.5"
RESPONSE 200 { "id": "dist_001234", "name": "Rahul Sharma", "email": "rahul@example.com", "rank": "Silver Director", "sponsor_id": "dist_000890", "placement_id": "dist_000890", "leg": "left", "personal_volume": 1250.00, "group_volume": 48500.00, "status": "active", "joined_at": "2024-03-15T10:30:00Z", "ewallet_balance": 12450.00 }
API Rate Limits: Standard plan: 1,000 requests/hour. Enterprise plan: 10,000 requests/hour. Exceeding limits returns HTTP 429 Too Many Requests. Contact support for higher limits.

Integrations v2.5

Connect Global MLM Software with your CRM, ERP, shipping, payment gateway, and third-party tools.

CRM Integrations
Salesforce, HubSpot, Zoho CRM, Freshsales — native connectors available in Admin Panel.
Payment Gateways
Stripe, PayPal, Razorpay, PayU, CCAvenue, Instamojo, 2Checkout and 45+ more.
Email / SMS
SendGrid, Mailchimp, Twilio, MSG91 — automated transactional email & SMS.
Shipping Providers
Shiprocket, Delhivery, FedEx, DHL, UPS — real-time tracking & label generation.
ERP Systems
SAP, Oracle NetSuite, Tally, QuickBooks — via REST API or native connector.
Zapier / Make
Connect to 3,000+ apps using Zapier webhooks or Make (Integromat) automation.

Integration Setup

PATH Admin PanelSettingsIntegrationsCRM → Select provider → Authorize OAuth → Map fields ↳ Payment Gateway → Enter API keys → Test connection → Go live ↳ Email/SMS → Enter credentials → Configure templates → Test send ↳ Shipping → API keys → Default carrier → Label settings ↳ API Keys → Generate / Revoke API tokens for REST API access ↳ Webhooks → Add endpoint URL → Select events → Test delivery

Compliance Tools v2.5

KYC/AML tools, tax document generation, FTC/DSA compliance checks, audit logs, and GDPR controls.

Global MLM Software includes a comprehensive compliance suite designed to help direct selling companies meet regulatory requirements across 60+ countries. The compliance module covers identity verification, transaction monitoring, tax documentation, and full audit trail management.

Compliance Features

  • KYC Verification: Government ID, PAN, GST, Aadhaar upload and verification workflow
  • AML Screening: Sanction list check via third-party integration (ComplyAdvantage, Dow Jones)
  • Tax Documents: Auto-generate TDS certificates, 1099 forms (USA), GST invoices (India)
  • FTC / DSA Rules: Configurable 70% end-user sales rule monitoring, income disclosure statement generation
  • GDPR Controls: Data export, right to erasure, consent management, data processing records
  • Audit Log: Immutable timestamped record of all admin and distributor actions
  • Commission Audit: Full recalculation and reconciliation tool for compliance reviews
Compliance Assistance: Our team has helped 60+ companies obtain regulatory approvals in India (MCA, DSA), USA (FTC compliance), UK, UAE, and Southeast Asia. Contact your account manager for country-specific compliance documentation support.

Analytics & Reports v2.5

50+ pre-built reports, custom dashboards, AI-powered insights, and data export tools.

The Analytics module provides comprehensive reporting across all platform dimensions — recruitment, volume, commissions, rank advancement, retention, geographic distribution, product performance, and payout analysis. Reports are available in the Admin Panel, via API, or as scheduled email exports.

Key Reports Available

  • Distributor Recruitment Report — daily/weekly/monthly new joinings
  • Commission Payout Report — total commissions by type, by period, by rank
  • Volume Report — PV/GV by level, by region, by product category
  • Rank Advancement Report — who advanced, when, from which rank
  • Retention & Churn Report — active vs inactive distributors by cohort
  • Geographic Distribution — map view of distributor density by country/state
  • Product Sales Report — units sold, revenue, commission generated per product
  • Binary Leg Balance Report — left/right leg volume comparison across top leaders
  • AI Churn Prediction — distributors at risk of going inactive in next 30 days
  • Income Disclosure Statement — regulatory-compliant IDS report
Export Formats: All reports support PDF, Excel (XLSX), and CSV export. Scheduled report delivery to email can be configured in Admin Panel → Analytics → Report Scheduler with daily, weekly, or monthly frequency.

Frequently Asked Questions

Common questions about Global MLM Software setup, configuration, and technical support.

Standard MLM software setup with a pre-configured Binary or Unilevel plan takes 48–72 hours from contract signing to go-live. This includes distributor registration portal, product catalogue with up to 500 SKUs, compensation plan configuration, commission engine setup, replicated website template, e-wallet, and mobile app. Custom plans with unique compensation structures, third-party ERP integrations, or proprietary bonus types require 4–8 weeks and come with 30-day post-launch support.
Yes. Global MLM Software provides a comprehensive REST API with 50+ endpoints for distributor management, commission calculations, genealogy tree queries, product catalogue, order management, e-wallet transactions, rank advancement events, and analytics data. The API uses OAuth 2.0 bearer token authentication, supports JSON request/response format, and includes webhook support for real-time event notifications. API tokens are generated in Admin Panel → Settings → API Keys.
Commission rules are configured in Admin Panel → Compensation Plan → Commission Engine. You can define: (1) Direct referral bonus percentage, (2) Level-based commission rates, (3) Matching bonus percentage tiers, (4) Rank-based override rates, (5) Capping rules per cycle, (6) Minimum payout thresholds, and (7) Cycle frequency (daily, weekly, bi-weekly, monthly). Our implementation team configures all rules during your onboarding session; this guide covers ongoing adjustments.
Yes. Global MLM Software integrates with Salesforce, HubSpot, Zoho CRM, and Freshsales out of the box via Admin Panel → Settings → Integrations → CRM. Custom CRM integrations are available through the REST API. The platform also supports Zapier webhooks for connecting to 3,000+ apps. API documentation and sample code are available in this documentation.
White-label mobile app configuration is available in Admin Panel → Mobile App → Branding. Upload your company logo, set primary and secondary brand colors, configure app name and store listing details, set up push notification content, and choose which modules to show or hide. The white-label app is published under your company name on iOS App Store and Google Play Store. The process typically takes 7–14 days for initial store approval.
Exceeding API rate limits returns HTTP 429 Too Many Requests with a Retry-After header indicating when you can retry. Standard plan limit is 1,000 requests/hour; Enterprise plan is 10,000 requests/hour. For higher limits, contact your account manager or submit a support ticket in Admin Panel → Support → Rate Limit Increase Request.
Technical support is available 24/7 through: (1) Admin Panel → Support → Create Ticket — for complex technical issues, (2) WhatsApp: +91-9758521366 — for urgent issues, (3) Email: support@global-mlm.com — for non-urgent issues. Standard plan includes business hours dedicated support; Enterprise plan includes 24/7 dedicated account manager with a 2-hour SLA for critical issues. Check the status page at status.global-mlm.com for platform health updates.

Need Help? Request a Live Platform Demo

Our implementation specialists can walk you through any part of the platform — live, screen-shared, and tailored to your specific setup requirements.

Live Admin Panel walkthrough
Commission engine configuration demo
API integration guidance
Genealogy tree & reporting tour
Response within 2 business hours
24/7 WhatsApp support available
Request Platform Demo

Secure. No spam. Response within 2 business hours.