# HYBRID MLM SOFTWARE ## Docs - [Introduction](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/folder-1317584.md): ## API Docs - Authorization > Login [login](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6599672.md): Welcome to the Login API documentation! .The User Login endpoint allows registered users to authenticate themselves and obtain access to protected resources within the system. Upon successful authentication, the server generates an authentication token that should be included in subsequent requests to authorize access to restricted endpoints. - Authorization [Forget Password](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7453690.md): This endpoint initiates the process of resetting a user's password. It sends an email containing a password reset link to the email address associated with the account. The link typically includes a token that is required to verify the user's identity and allow them to set a new password. - Register [Fetch Country List ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6681385.md): Welcome to the Get Countries API documentation! This API provides endpoints to retrieve information about countries worldwide. By integrating these endpoints into your application, you can access a comprehensive list of countries along with their associated details. - Register [Fetch State List ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6682970.md): Welcome to the Get States API documentation! This API provides endpoints to retrieve information about states or provinces within countries worldwide. By integrating these endpoints into your application, you can access a comprehensive list of states along with their associated details. - Register [Username Existence Checker ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6694952.md): Welcome to the Check Username API documentation! This API provides endpoints to verify whether a username already exists within the system. By integrating these endpoints into your application, you can efficiently validate username availability before allowing users to proceed with account creation or other actions requiring unique usernames. - Register [Email Existence Checker ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6694959.md): Welcome to the Check Email API documentation! This API provides endpoints to verify whether an email address already exists within the system. By integrating these endpoints into your application, you can efficiently validate email address availability before allowing users to proceed with account creation or other actions requiring unique email addresses. - Register [Sponsor Verification ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6687410.md): Welcome to the Verify Sponsor API documentation! This API provides endpoints to verify whether a sponsor exists within the system. By integrating these endpoints into your application, you can easily determine the presence of a sponsor before proceeding with related actions. - Register [User Registration ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6619504.md): Welcome to the User Registration API documentation! This API provides endpoints for seamless user registration within your applications. By integrating these endpoints, you can allow users to create accounts quickly and efficiently, enabling them to access your platform's features and services. - Profile [Retrieves User Profile Information](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6621092.md): Welcome to the Get Profile API documentation! This API provides endpoints to retrieve user profile informatio from the system. By integrating these endpoints into your application, you can access user-specific details such as username, email address and other relevant information. - Profile [Modify User Profile Information ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6622105.md): Welcome to the Update Profile API documentation! . The Update Profile endpoint allows users to modify their profile information. This can include personal details such as name, email, or any other relevant information associated with their account. - Dashboard [Fetch Dashboard Data ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6695247.md): Welcome to the Dashboard Data API documentation! The Dashboard Data endpoint allows users to fetch data related to the dashboard of their account. This could include commission info,refferrals,total payout,total balance,top sponsors and earners or any other relevant data to provide users with insights into their account activity or system status. - Payout > Payout Pin [Check Payout Pin Status ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6879006.md): This endpoint allows you to check whether a payout PIN is set for a specific user account. A payout PIN is a security measure used to verify the identity of the user before processing payout requests or sensitive operations. By utilizing this endpoint, you can determine whether the user has set up a payout PIN and implement additional security measures as needed. - Payout > Payout Pin [Initiate User Payout Pin Creation ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7115270.md): This endpoint allows you to check whether a payout PIN is set for a specific user account. A payout PIN is a security measure used to verify the identity of the user before processing payout requests or sensitive operations. By utilizing this endpoint, you can determine whether the user has set up a payout PIN and implement additional security measures as needed. - Payout > Payout Pin [Update User Payout Pin ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6879410.md): This endpoint allows users to update their payout PIN for added security when processing payout requests or sensitive operations. A payout PIN is a numeric code used to authenticate and authorize payout transactions. By utilizing this endpoint, users can securely update their payout PIN to ensure the protection of their funds and account information. - Payout > Payout Pin [Manage Forgotten Payout Pin ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6883665.md): The Forget Payout PIN API provides a mechanism for users to reset or recover their payout Personal Identification Number (PIN). By sending a POST request to this endpoint can generate a random nunmber(PIN) and send it by a mail.This payout pin is used for further payout - Payout > Payout Accounts [Retrieve User Payout Accounts List](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6879468.md): This endpoint allows you to retrieve information about a user's account that already used to withdraw the amount.By utilizing this endpoint, you can get the user accounts within your system. - Payout > Payout Accounts [Retrieve Account Fields Data ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6955119.md): This endpoint allows you to retrieve the fields associated with a specified gateway within your system. These fields are mandatory to save the user account for corresponding gateways in addPayoutAccount API.By querying this endpoint, you can obtain a list of fields specific to a particular gateway, providing insight into the type of data it collects or manages. - Payout > Payout Accounts [Register Payout Account For User ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6955125.md): This endpoint allows you to save account details for corresponding gateways within your system. Account fields get from getAccountFields API for corresponding gateway.These fields are mandatory to save the user account. By sending a POST request to this endpoint with the necessary data, you can create a new account. - Payout > Payout Accounts [Delete User Payout Account ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6955557.md): This endpoint allows you to delete a user account from your system. Deleting an account typically involves permanently removing all details associated with an user specified account. By sending a POST request to this endpoint with the necessary authentication and user account_id, you can initiate the deletion process for the specified account. - Payout > New payout Request [Retrieves Payout Wallets List ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6878807.md): This endpoint allows you to retrieve a list of available payout wallets supported by the system. The payout wallet is where funds are deposited or withdrawn for transactions and payouts. By using this endpoint, you can access details such as the wallet ID, wallet name,associated with payout wallet. - Payout > New payout Request [Initiate New Payout Request ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6878911.md): This endpoint allows you to initiate a payout request to transfer funds from the platform to a user's designated external account or wallet. Payout requests facilitate to withdraw the amount in the users wallet. - Payout [Retrieve Payout Gateways ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6878849.md): This endpoint allows you to retrieve a list of available payout gateways supported by the system. Payout gateways are the channels through which funds can be transferred or disbursed to users or accounts. By utilizing this endpoint, you can obtain information about each available payout gateway, including its relevant details. - Payout [Revoke User Payout Request ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6971867.md): This endpoint allows users to cancel a payout request that has been initiated but not yet processed by the system. This endpoint provides a straightforward way to prevent a payout from being completed if necessary. - Payout [Check Payout Status ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6879378.md): This endpoint allows you to retrieve the different status and their ID of a payout transaction within your system.Payout status indicates the current state of the payout transaction, whether it's completed, pending, failed, or any other relevant status.By using this API can understand the status corresponding to its ID. - Payout [Retrieve Payout History Data ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6879133.md): This endpoint allows you to retrieve the payout history for a specific user account. Payout history provides a record of all past payout transactions initiated from the user's account, including details such as transaction ID, amount, date, status, and any other relevant information. By utilizing this endpoint, you can access the user's payout history for auditing, reporting, or reconciliation purposes. - Wallet > Transaction Password [Check Transaction Password Status ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6956443.md): The Is Transaction Password Set API allows you to verify whether a user has set a password for their wallet account. This endpoint is useful for implementing password security checks or enforcing password setup requirements. - Wallet > Transaction Password [Initiate User Transaction Password ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7117525.md): This API documentation outlines the process for creating a transaction password for users who are setting it up for the first time. The transaction password is a crucial security feature for financial transactions and ensures the safety of user accounts. - Wallet > Transaction Password [Update Transaction Password For User ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6956454.md): The Update Wallet Password API enables users to change or update their existing wallet password. This endpoint provides a secure way for users to manage their wallet security by allowing them to set a new password as needed. - Wallet > Transaction Password [Manage Forgotten Transaction Password](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7033368.md): The Forget Wallet Password API provides a mechanism for users to reset or recover their wallet Password. By sending a POST request to this endpoint can generate a random nunmber(Password) and send it by a mail.This wallet password is used for further wallet - Wallet [Retrieve List Of Wallets ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7089105.md): This endpoint allows you to retrieve a list of available wallets supported by the system. The wallet is where funds are deposited or withdrawn for transactions . By using this endpoint, you can access details such as the wallet ID, name and slug of all wallet supporrted by the system. - Wallet [Fetch Wallet Balance ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7033394.md): The Get Balance API allows users to retrieve their current account balance of corresponding wallet.You will get wallet id from getWalletList API. This endpoint is useful for applications that need to display the user's available balance information of corresponding wallets. - Wallet [Initiate Funds Transfer ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7089302.md): The Get Transfer Fund API allows users to transfer of money between different accounts or entities within a system. You will get wallet details from getWalletList API. - Wallet [Retrieve Transaction Operations ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6956479.md): The Transaction Operations API allows you to retrieve information about transaction operations, including ID,name and slug. - Wallet [Retrieve User Transactions ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-6886020.md): The Get Transactions API enables you to retrieve a list of transactions associated with a user's wallet. This endpoint provides information about transactions such as deposits, withdrawals, transfers, and other activities. - News [Fetch All News ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7230172.md): The News Listing API provides developers with access to a comprehensive collection of news articles . With this API, developers can retrieve news articles within the system. - News [Fetch Single News ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7230412.md): The Show News by ID API endpoint allows developers to retrieve detailed information about a specific news article using its unique identifier (ID). - Reports > Earning Report [Fetch Earning Report Filter Details ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7250967.md): The Fetch Earning Report Filters API provides developers with endpoints to retrieve available filters for fetching earning reports. These filters enable users to customize and narrow down their search criteria, enhancing the flexibility and efficiency of accessing earning data. - Reports > Earning Report [Show Filtered Earning Report ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7251316.md): The Show Filtered Earning Report API allows developers to retrieve earning report data based on specified filters. This API endpoint facilitates the retrieval of earning data , enabling users to analyze and review earnings in accordance with their requirements. - Reports > Refferal List [Fetch User Referral List](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7251344.md): The Referral Listing API allows developers to retrieve information about referrals in an application or system. This documentation provides details on how to authenticate, request, and handle responses from the Referral Listing API. - Reports > Downline List [Fetech User Downline List ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7251352.md): The Downline Listing API facilitates the retrieval of information about downlines within a network marketing or hierarchical structure. Downlines represent users who are recruited or sponsored by other users, forming a multi-level network. This documentation outlines how developers can authenticate, request, and handle responses from the Downline Listing API. - Mail [Compose Mail](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7383705.md): The Compose Email API allows developers to programmatically create and send emails from their applications. This API provides endpoints to compose, send, and manage email content. - Mail [Reply Mail](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7385382.md): The Reply Email API allows developers to programmatically reply to existing emails within their applications. This API provides endpoints to create replies, manage reply content, and ensure proper threading of email conversations. - Mail [Retrieve Inbox Mails](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7386693.md): The Get Inbox Emails API allows developers to programmatically retrieve emails from a user's inbox. This API provides endpoints to fetch email details. - Mail [Retrieve Send Mails](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7386900.md): The Get Sent Emails API allows developers to programmatically retrieve emails that have been sent from a user's account. This API provides endpoints to fetch sent email details. - Mail [ Star Mail](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7454004.md): This endpoint allows the authenticated user to star a specific email. Starring an email typically marks it as important or makes it easier to find in a starred folder. - Mail [UnStar Mail ](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7454065.md): This endpoint allows the authenticated user to unstar a specific email. Unstarring an email typically removes its marked importance or removes it from a starred folder. - Mail [Retrieve Starred Mail](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7454073.md): This endpoint retrieves a list of all emails that have been starred by the authenticated user. Starred emails are those marked as important or marked for easy access. - Mail [Retrieve Trashed Mail](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7454077.md): This endpoint retrieves a list of all emails that have been moved to the trash by the authenticated user. - Mail [Delete Mail](https://apidog.com/apidoc/shared/dbd2636f-8daa-4f8b-966d-fdac5d89305f/api-7454081.md): This endpoint allows the authenticated user to delete a specific email permanently. Once deleted, the email cannot be recovered.