> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null. > When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. # Onboarding > Fill in and submit the Fluid Payments onboarding form, from business, bank and owner details to countries and a compliance questionnaire. The **Onboarding** screen holds your company's Fluid Payments onboarding form. Fluid uses what you enter to apply to payment processors for you and to turn on the right payment methods in each market where you sell. ## Where to find it In the admin, click the **Settings** gear in the top bar. In the Settings sidebar, under **Company**, select **Onboarding**. If **Onboarding** isn't in your Settings sidebar, your role can't view **Payments Onboarding**. If you can open the form but can't change anything, your role can view **Payments Onboarding** but not edit it. An admin who manages roles can change this on [Roles](/help/admin/settings/roles). On the role's **Permissions** tab, the permission is **Payments Onboarding**, in the **Commerce** card. You need legal authority to sign contracts for your company. On the last step, you certify that you're authorized to sign the Fluid Terms & Conditions. Allow 30 to 60 minutes. The time depends on how complex your business is and how many entities and owners it has. ## What's on the screen The **Payment Setup Progress** list is on the left, and the step you're on fills the rest of the screen. ### Payment Setup Progress The list shows all 10 steps in order. Under each step's name is its status: **Complete**, **In progress** with a percentage, or **Pending**. Click a step to go to it. Your changes on the current step save before the step you clicked opens. ### Saving your work * Your changes save automatically as you work. The top right of the form shows **Saving…** and then **All changes saved**. If a save fails, an error appears in the same place. * Most cards also have a **Save** button if you want to save right away. * When a step is complete, a box at the bottom of the step confirms it. Click its button (**Next**, **Continue** or **Save Draft & Continue**) to save the step and move on. * Until that box appears, some steps show a **Save Progress** button instead. ### 1. The Basics This step asks yes-or-no questions about how your company is owned and run. More questions appear as you answer. Your answers shape the rest of the form. * **Is your company an MLM?** If you answer **Yes**, the ownership questions below and **Relevant Persons** use 10% instead of 25%. The form also adds MLM questions to **Underwriting**. * **Is there any individual that owns 25% or more of your company?** * If you answer **Yes**, the form also asks **Do you personally legally own 25% or more of your company?** * **Is there any business entity that owns 25% or more of your company?** * **Are there any other legal entities in connection with your company?** For example, subsidiaries or sister companies you use to do business in other countries. * **Please provide a chart showing how your business is owned and controlled.** Upload a chart of all owners and legal entities up to the ultimate parent. Click **See example** to see a sample. If you don't have the chart yet, click **Skip for Now**. * If your company is an MLM, the chart is required. If you skip it here, upload it on **Underwriting** under **MLM Specific Information**. * **Do you personally have significant authority over how the company is run?** appears after you upload the chart or click **Skip for Now**. * **Are you an authorized signatory for the company?** appears once you answer the authority question. ### 2. Business Info The **Primary legal entity info** card holds your primary business entity's details. Enter them exactly as they appear on official documents. * **Basic Information**: **Legal Name**, and a **Trading Name** if your business operates under a different name. * **Registered Office Address**: country, street address, city, state or province, and postcode. **Registered office address and principal place of business are the same** is selected by default. If your principal place of business is at a different address, clear the checkbox and enter that address under **Principal Place of Business**. * **Additional Information**: **Classification**, **Primary Merchant Category Code (MCC)**, an optional **Secondary Merchant Category Code (MCC)**, **Phone Number** and **Website**. The **Classification** options depend on the registered office country, so choose the country first. * **Tax Information & Registration**: your tax ID, **Business Registration Number**, **Business Registration Certificate** and **Date of Incorporation**. The tax ID field is **Employer Identification Number (EIN)** for a US entity, **VAT-ID** for an entity in a VAT country, and **Business Tax ID** everywhere else. A US entity also uploads a **W-9 (signed within the past 6 months)**. * **Required Documents**: **Business License** and **Articles of Incorporation**. You can also add your **Last 3 Months of Payment Processing Statements** from your current payment provider. ### 3. Legal Entities This step is titled **Additional Legal Entities**. Your primary entity from **Business Info** is listed first, marked with a star. If your business includes other legal entities, such as subsidiaries, related companies or entities in other countries, click **Add additional legal entity** for each one. Each entity has the same fields as **Business Info**. If you have only one entity, continue to the next step. ### 4. Primary Bank Account Enter the account that receives payouts for your primary entity from all connected processors. Until your primary entity is saved on **Business Info**, this step asks you to complete **Business Info** and **Legal Entities** first. * **Associated Entity**: if you have more than one entity, choose the **Legal Entity** the account belongs to. * **Bank Information**: **Bank Name**, **Country**, **City**, **Account Holder Name**, **Currency** and **Account Number**. A US account also needs a **Routing Number**. An account in another country needs a **SWIFT/BIC Code**. * **Required Documents**: **Last 3 Months of Bank Statements** and a **Bank Letter or Voided Check**. ### 5. Additional Bank Accounts This step is titled **Bank Accounts**. Your primary account is listed first. If you added other legal entities, add a payout account for each one. Click **Add bank account** next to each entity. If you use **+ Add another bank account** instead, choose the entity in the account's **Legal Entity** field. Each account has the same fields as **Primary Bank Account**. ### 6. Personal Info This step is titled **Personal Information**. In the **Your Information** card, enter your own details as the primary contact and decision-maker for the business. Every payment processor Fluid connects you with requires identity verification for the people behind a business. * **Associated Entity**: choose the **Legal Entity** you represent. * **Personal Information**: **Full Name** as it appears on your government ID, **Date of Birth**, **Place of Birth** and **Nationality (country)**. If your official documents use a non-Latin script, select **I use a different name in my country of origin** and enter your **Native Name**. * **Contact Information**: **Work Email**. * **Residential Address**: country, street address, city, state and postcode, plus your **Phone Number**. * **Role**: your **Job Title**. Then select each role that applies: **Is Managing Director**, **Is Beneficial Owner** or **Is Authorized Signatory**. A beneficial owner also enters a **Percent Ownership**. * **Identification & Documents**: * Your **Social Security Number** if your residential country is the United States. Otherwise, your **Government ID Number**. * **Government Issued ID**: choose **Passport** and upload the photo page, or choose **Driver's License** or **National ID** and upload the front and back. * **Proof of Residence** from the last 60 days, such as a utility bill or bank statement. ### 7. Relevant Persons This step is titled **Other Relevant Persons**. Until **Business Info** and **Personal Info** are saved, this step asks you to complete them first. List the other people who own or run the business: * Anyone who owns 25% or more of the company (10% for an MLM). * Your company's CEO, President or CFO, if that isn't you. Your own entry is marked **(You)**. Click **Add relevant person** to add each other person. Each person has the same fields as **Personal Info**. The **Relevant Persons Complete** box appears once every person's required fields are filled in. If you answered **Yes** to the individual-owner question on **The Basics**, at least one person must also be marked **Is Beneficial Owner**. Each beneficial owner's **Percent Ownership** must be at or above the ownership threshold. ### 8. Countries This step is titled **Countries & Markets**. Add each country where you operate. Fluid uses this to decide which payment methods and currencies to turn on for each market. For each country, fill in: * **Country**: the market you're adding. * **Auth Currency**: the currency your customer pays in. * **Settlement Currency**: the currency you receive. If it's the same as the auth currency, select **Auth and Settlement currencies are the same** to use a single **Currency** field. * **Legal Entity**: the entity that serves this market. * Select the required checkbox that confirms **The selected entity is legally registered to do business in** that country. When the two currencies differ, currency conversion happens automatically at settlement, and fees and exchange rates may apply. Click **Add another country** for each additional market. If the button reads **Create an entity first**, save your entity on **Business Info** before you add countries. Once a country is complete, its **Save** button reads **Update**. ### 9. Underwriting This step is titled **Direct Sales Compliance & Operations Questionnaire**. Payment processors review these answers as part of their approval process. The **Business Information & Compliance** card has these sections: * **Company Structure & Operations**, in this order: * **Company Description** and **Management Stability**. * **MLM Specific Information**, if you answered **Yes** to **Is your company an MLM?** It asks for your **MLM Structure** and the ownership chart. Then it asks for a URL or file for six documents: **Distributor Policies & Procedures**, **Sample Distributor Agreement**, **Business Opportunity Disclosures**, **Income Disclosure Statement**, **Fulfillment Agreement** and **Manufacturing Agreement**. Last, it asks for a list of owners and principals with more than 10% ownership. * Whether you use a **Third Party Accounting Firm**, and whether your **Financials** are audited. * Your **Projected Annual Sales Volume** and **Average Order Value**. * Financial documents for your two most recent fiscal years. * **Transaction Type Split (MIT/CIT)**: enter **% One-Time Purchase (CIT)** or **% Recurring/Monthly Auto-Ship (MIT)**, and the form fills in the other. The two must total 100%. * **Legal & Compliance**: compliance officer, monitoring policies and legal counsel. For your **Terms & Conditions**, **Refund/Return Policy** and **Privacy Policy**, give a URL or upload a file. * **Compensation & Payments** and **Distributor Management**: these sections appear only when you answered **Yes** to **Is your company an MLM?** on **The Basics**. * **Health Products & Supplements**: turn on **Does your company sell vitamins, dietary or health care supplements?** if it does, then answer the questions that appear. * **Investigations & Reputation**: legal investigations, negative media and business ratings. * **Third-Party Agreements (Optional)**: your **Fulfillment Agreement** and **Manufacturing Agreement**, if you have them. For an MLM, both agreements are required. You can upload them here or give them under **MLM Specific Information**. ### 10. Terms & Conditions The **Agreement** card is where you review and accept the Fluid Terms & Conditions, which submits the form. See [Submit the form](#submit-the-form). ## Complete the form On **The Basics**, click **Review** in the **Get to know this form** box. Read the **What You'll Need** checklist, then click **Continue**. Have your documents ready as files up to 10 MB. Most uploads accept only PDF, DOC or DOCX. The ownership chart on **The Basics** also accepts JPEG and PNG, and the government ID accepts PDF, JPG or PNG. Answer every question, including the authority and signatory questions at the end. Then click **Next**. Fill in each step from **Business Info** to **Underwriting**. When a step's completion box appears, click **Save Draft & Continue** (**Continue** on the bank account steps) to save the step and move to the next one. Then [submit the form](#submit-the-form). ## Submit the form Click **Terms & Conditions** in **Payment Setup Progress**. If a warning says some steps are still incomplete, it lists each one with the number of fields remaining. Use **Payment Setup Progress** to open each step and complete it. Click **View Terms** to read the **Fluid Terms & Conditions**. To read them in a separate tab, click **Open in new tab**. Select **I certify that I am authorized to fill out this form & sign the Fluid Terms & Conditions for my company**. Then click **Accept and Continue**. After you submit, the screen shows **Your Onboarding Form Has Been Submitted** and a **What Happens Next** timeline. The timeline runs from **Submission Review** to **Live Testing**. Every step in **Payment Setup Progress** then shows **Complete**, and you can no longer change the form. Fluid contacts you if it needs anything else. To track the setup, click **View Payments Status Dashboard**. ## Remove an entity, account, person or country Expand the item's card and click **Delete**. Your primary entity (starred on **Legal Entities**), your primary bank account and your own entry (marked **(You)** on **Relevant Persons**) have no **Delete** button. Clicking **Delete** removes a legal entity, bank account or relevant person right away, without asking you to confirm. Only countries ask you to confirm, in the **Delete Country** dialog. Deleting a legal entity also deletes every bank account and person assigned to it. Before you delete an entity, change the **Legal Entity** of any country on the **Countries** step that uses it, or delete that country. ## FAQ The button stays grayed out while the warning on **Terms & Conditions** lists incomplete steps, and until you select the certification checkbox. Yes. Your changes save as you go, so you can leave the screen and come back to finish. If the screen shows **Your Onboarding Form Has Been Submitted**, the form is submitted and locked. Otherwise, check your role permissions as described under [Where to find it](#where-to-find-it). ## Related pages * [Settings](/help/admin/settings) * [Roles](/help/admin/settings/roles) * [Countries](/help/admin/settings/countries) * [APM](/help/admin/settings/apm) * [Getting help](/help/getting-help)