# MLM Platform Developer Docs

## Docs

- [Approve KYC](https://docs.mlm-platform.com/api-reference/admin-kyc/approve-kyc.md)
- [Get KYC review detail](https://docs.mlm-platform.com/api-reference/admin-kyc/get-kyc-review-detail.md)
- [Get signed preview URL for a KYC document](https://docs.mlm-platform.com/api-reference/admin-kyc/get-signed-preview-url-for-a-kyc-document.md)
- [List KYC reviews](https://docs.mlm-platform.com/api-reference/admin-kyc/list-kyc-reviews.md): Canonical endpoint. Alias of `GET /api/v1/admin/kyc/pending`.
- [List KYC reviews (alias)](https://docs.mlm-platform.com/api-reference/admin-kyc/list-kyc-reviews-alias.md): Alias of `GET /api/v1/admin/kyc`.
- [Reject KYC](https://docs.mlm-platform.com/api-reference/admin-kyc/reject-kyc.md)
- [Request KYC document resubmission](https://docs.mlm-platform.com/api-reference/admin-kyc/request-kyc-document-resubmission.md)
- [Request KYC document resubmission (alias)](https://docs.mlm-platform.com/api-reference/admin-kyc/request-kyc-document-resubmission-alias.md): Alias of `POST /api/v1/admin/kyc/{kycId}/request-resubmit`.
- [Create or update an external auth provider](https://docs.mlm-platform.com/api-reference/auth/create-or-update-an-external-auth-provider.md): Creates a new external auth provider or updates an existing one. If a provider with the same `provider_id` exists, it will be updated. Requires tenant admin authentication.
- [Exchange external JWT for MLM tokens](https://docs.mlm-platform.com/api-reference/auth/exchange-external-jwt-for-mlm-tokens.md): Exchanges a JWT from an external identity provider (e.g., Open Ears) for MLM platform access and refresh tokens. If the user doesn't exist and auto-creation is enabled for the provider, a new user is created.
- [Find MLM user by external ID](https://docs.mlm-platform.com/api-reference/auth/find-mlm-user-by-external-id.md): Finds an MLM user by their external provider ID.
- [Get JSON Web Key Set](https://docs.mlm-platform.com/api-reference/auth/get-json-web-key-set.md): Returns the public keys used to verify JWTs.
- [Get OIDC discovery configuration](https://docs.mlm-platform.com/api-reference/auth/get-oidc-discovery-configuration.md): Returns the OpenID Connect discovery document.
- [Link external user to MLM user](https://docs.mlm-platform.com/api-reference/auth/link-external-user-to-mlm-user.md): Links an external user ID to an existing MLM user.
- [List external auth providers](https://docs.mlm-platform.com/api-reference/auth/list-external-auth-providers.md): Returns all external auth providers configured for the tenant. Requires tenant admin authentication.
- [Refresh an access token](https://docs.mlm-platform.com/api-reference/auth/refresh-an-access-token.md): Uses a refresh token to obtain new access and refresh tokens.
- [Revoke a token](https://docs.mlm-platform.com/api-reference/auth/revoke-a-token.md): Revokes an access or refresh token.
- [Validate an access token](https://docs.mlm-platform.com/api-reference/auth/validate-an-access-token.md): Validates an access token and returns its claims.
- [Get annual tax summary](https://docs.mlm-platform.com/api-reference/commissions/get-annual-tax-summary.md): Returns annual tax summary for a member.
- [Get commission breakdown](https://docs.mlm-platform.com/api-reference/commissions/get-commission-breakdown.md): Returns commission breakdown by source, status, and level.
- [Get commission history](https://docs.mlm-platform.com/api-reference/commissions/get-commission-history.md): Returns paginated commission history for a member.
- [Record a purchase event](https://docs.mlm-platform.com/api-reference/events/record-a-purchase-event.md): Records a purchase event and triggers commission calculation for the buyer's upline. Commissions are created based on the tenant's commission rules and the compressed upline.
- [Get member's downline tree](https://docs.mlm-platform.com/api-reference/genealogy/get-members-downline-tree.md): Returns the hierarchical downline tree for a member.
- [Get member's upline path](https://docs.mlm-platform.com/api-reference/genealogy/get-members-upline-path.md): Returns the path from a member to the root of the hierarchy.
- [Get relationship between two members](https://docs.mlm-platform.com/api-reference/genealogy/get-relationship-between-two-members.md): Returns the relationship and path between two members.
- [API Reference](https://docs.mlm-platform.com/api-reference/introduction.md)
- [Create signed upload URL for KYC document bytes](https://docs.mlm-platform.com/api-reference/kyc/create-signed-upload-url-for-kyc-document-bytes.md): Returns a short-lived signed upload URL and `filePath` for uploading document bytes to the `kyc-documents` storage bucket.
- [Get KYC status and documents](https://docs.mlm-platform.com/api-reference/kyc/get-kyc-status-and-documents.md): Returns the current KYC status and a summary of uploaded documents.
- [List uploaded KYC documents](https://docs.mlm-platform.com/api-reference/kyc/list-uploaded-kyc-documents.md)
- [Record KYC document metadata after upload](https://docs.mlm-platform.com/api-reference/kyc/record-kyc-document-metadata-after-upload.md): Records KYC document metadata.
- [Start KYC verification](https://docs.mlm-platform.com/api-reference/kyc/start-kyc-verification.md): Starts the KYC process for a member. For manual KYC, returns upload instructions. For Sumsub KYC (if configured), returns `sdkConfig`.
- [Capture a lead](https://docs.mlm-platform.com/api-reference/leads/capture-a-lead.md): Captures a lead with optional referral attribution. Leads can be converted to members later using the member creation endpoint.
- [Create member payout account](https://docs.mlm-platform.com/api-reference/payout-accounts/create-member-payout-account.md): Creates a payout account and provisions a real Stripe Connect account for the member. The account is created with the `transfers` capability enabled, allowing the platform to send payouts.
- [Delete (deactivate) member payout account](https://docs.mlm-platform.com/api-reference/payout-accounts/delete-deactivate-member-payout-account.md)
- [Get member payout account](https://docs.mlm-platform.com/api-reference/payout-accounts/get-member-payout-account.md)
- [List member payout accounts](https://docs.mlm-platform.com/api-reference/payout-accounts/list-member-payout-accounts.md)
- [Update member payout account](https://docs.mlm-platform.com/api-reference/payout-accounts/update-member-payout-account.md): Supports setting `isPrimary` and/or deactivating via `isActive=false`.
- [List payout methods with field metadata](https://docs.mlm-platform.com/api-reference/payout/list-payout-methods-with-field-metadata.md): Returns payout method definitions (per country) including full field metadata for dynamic form rendering. Each method includes an `enabled` flag derived from tenant configuration.
- [Generate referral QR code](https://docs.mlm-platform.com/api-reference/referrals/generate-referral-qr-code.md): Generates a QR code for a member's referral link.
- [Get referral link for a user](https://docs.mlm-platform.com/api-reference/referrals/get-referral-link-for-a-user.md): Returns the referral link and code for a specific user. The link can be shared to attribute new leads and members to this user.
- [Get referral statistics](https://docs.mlm-platform.com/api-reference/referrals/get-referral-statistics.md): Returns referral statistics for a member.
- [Create a new member](https://docs.mlm-platform.com/api-reference/users/create-a-new-member.md): Creates a new member in the MLM hierarchy. The member can optionally be placed under a parent (sponsor) using `parent_id` or `referral_code`.
- [Get member profile](https://docs.mlm-platform.com/api-reference/users/get-member-profile.md): Retrieves the member's profile including country code and address information.
- [Get user status and commission summary](https://docs.mlm-platform.com/api-reference/users/get-user-status-and-commission-summary.md): Returns the current status of a user including their commission balance, membership tier, and activity status.
- [Update member profile](https://docs.mlm-platform.com/api-reference/users/update-member-profile.md): Updates the member's profile fields such as country code and address.
- [Stripe webhook receiver](https://docs.mlm-platform.com/api-reference/webhooks/stripe-webhook-receiver.md): Receives Stripe webhook events. Validates the `stripe-signature` header against the per-tenant webhook secret stored in tenant settings. Use `environment=sandbox` when configuring Stripe test mode.
- [Sumsub KYC webhook receiver](https://docs.mlm-platform.com/api-reference/webhooks/sumsub-kyc-webhook-receiver.md): Receives Sumsub webhook events for KYC status updates.
- [Wise webhook receiver](https://docs.mlm-platform.com/api-reference/webhooks/wise-webhook-receiver.md): Receives Wise webhook events. Validates the `x-signature-sha256` header and processes payout transfer status updates. Use `environment=sandbox` when configuring Wise sandbox.
- [Create a widget access token](https://docs.mlm-platform.com/api-reference/widget/create-a-widget-access-token.md): Creates a Widget Access Token (WAT) for embedding the referral widget. The token is JWT-based and includes allowed origins for CORS validation.
- [Authentication](https://docs.mlm-platform.com/guides/authentication.md): Secure your API requests with tenant API keys
- [External Auth Providers](https://docs.mlm-platform.com/guides/external-auth-providers.md): Configure OIDC federation to allow users from your external system to access the MLM Platform
- [Getting Started](https://docs.mlm-platform.com/guides/getting-started.md): Make your first API call in minutes
- [KYC Verification](https://docs.mlm-platform.com/guides/kyc-verification.md): Complete guide to implementing Know Your Customer (KYC) verification for members
- [Sandbox Testing](https://docs.mlm-platform.com/guides/sandbox-testing.md): Test your integration safely with sandbox environments
- [Webhooks](https://docs.mlm-platform.com/guides/webhooks.md): Receive real-time notifications for Stripe events
- [Widget Embedding](https://docs.mlm-platform.com/guides/widget-embedding.md): Securely embed referral widgets in your application
- [Introduction](https://docs.mlm-platform.com/introduction.md): Welcome to the MLM Platform Developer Documentation
- [TypeScript SDK](https://docs.mlm-platform.com/sdks/typescript.md): Official TypeScript SDK for the MLM Platform API

## OpenAPI Specs

- [openapi](https://docs.mlm-platform.com/api/openapi.yaml)
- [openapi-integration](https://docs.mlm-platform.com/api/openapi-integration.yaml)

## Optional

- [GitHub](https://github.com/AVC-Revenue/MLM-Platform)
- [Community](https://discord.gg/mlm-platform)