> ## 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. > After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch. > 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. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/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. > The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations. > Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check. > Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times. # Update company onboarding info ## OpenAPI ````yaml /api-reference/onboarding-v0.yaml put /api/companies/{company_id}/onboarding_info openapi: 3.1.0 info: title: Fluid Onboarding API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app - url: https://{company}.fluid.app description: Production server with company subdomain variables: company: default: myco description: Company subdomain security: [] paths: /api/companies/{company_id}/onboarding_info: put: tags: - onboarding-info summary: Update company onboarding info operationId: onboarding_v0_update_company_onboarding_info parameters: - name: company_id in: path required: true example: 1 schema: type: integer requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateCompanyOnboardingInfoRequestBodyApplicationJsonSchema description: Request payload responses: '200': description: onboarding info updated content: application/json: schema: type: object properties: company: $ref: '#/components/schemas/OnboardingCompany' meta: $ref: '#/components/schemas/OnboardingMeta' required: - company '401': description: unauthorized - company access denied content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '409': description: >- onboarding_info_version is stale - the onboarding info changed after it was loaded, so the caller should re-fetch and reapply its changes content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: UpdateCompanyOnboardingInfoRequestBodyApplicationJsonSchema: type: - object - 'null' properties: onboarding_info_version: description: >- Revision the payload was built from, as returned by the GET. When supplied, a save built on a superseded revision is refused with 409 instead of overwriting concurrent edits. Omit to keep the previous last-write-wins behaviour. type: - integer - 'null' onboarding_info: type: - object - 'null' properties: beneficial_individual_owner: type: - boolean - 'null' beneficial_individual_owner_names: type: - array - 'null' items: type: - string - number - integer - 'null' user_is_owner: type: - boolean - 'null' beneficial_business_owner: type: - boolean - 'null' other_legal_entities: type: - boolean - 'null' user_has_authority: type: - boolean - 'null' user_is_signatory: type: - boolean - 'null' has_paypal_business_account: type: - boolean - 'null' user_is_primary_decision_maker: type: - boolean - 'null' business_structure_complexity: type: - string - number - integer - 'null' operates_internationally: type: - boolean - 'null' kyc_flow_current_step: type: - string - number - integer - 'null' kyc_flow_completed_steps: type: - string - number - integer - 'null' paypal_connected: type: - boolean - 'null' paypal_business_info_prefilled: type: - boolean - 'null' onboarding_steps: type: - object - 'null' properties: basic_info: type: - integer - string - number - 'null' paypal_connect: type: - integer - string - number - 'null' business_info: type: - integer - string - number - 'null' legal_entities: type: - integer - string - number - 'null' bank_accounts_i: type: - integer - string - number - 'null' bank_accounts_ii: type: - integer - string - number - 'null' personal_info: type: - integer - string - number - 'null' relevant_persons: type: - integer - string - number - 'null' countries: type: - integer - string - number - 'null' alternate_payment_methods: type: - integer - string - number - 'null' data_migration: type: - integer - string - number - 'null' agreements_and_policies: type: - integer - string - number - 'null' underwriting: type: - integer - string - number - 'null' terms_and_conditions: type: - integer - string - number - 'null' countries_info: type: - array - 'null' items: type: - object - 'null' properties: entity_id: type: - integer - string - number - 'null' currency: type: - string - number - integer - 'null' settlement_currency: type: - string - number - integer - 'null' entity_legally_registered: type: - boolean - 'null' country_id: type: - integer - string - number - 'null' country_iso: type: - string - number - integer - 'null' data_migration: type: - object - 'null' properties: active: type: - boolean - 'null' tokenization_provider: type: - string - number - integer - 'null' estimated_token_count: type: - integer - string - number - 'null' underwriting_info: type: - object - 'null' properties: company_description: type: - string - number - integer - 'null' minLength: 1 management_stability: type: - string - number - integer - 'null' minLength: 1 company_is_mlm: type: - boolean - 'null' not: type: - string - number - integer - 'null' mlm_ownership_structure: type: - string - number - integer - 'null' mlm_ownership_structure_file_url: type: - string - number - integer - 'null' mlm_ownership_structure_file_name: type: - string - number - integer - 'null' uses_third_party_accounting: type: - string - number - integer - 'null' minLength: 1 has_compliance_officer: type: - string - number - integer - 'null' minLength: 1 compliance_officer_responsibilities: type: - string - number - integer - 'null' minLength: 1 distributor_monitoring_policies: type: - string - number - integer - 'null' minLength: 1 suspicious_activity_escalation_process: type: - string - number - integer - 'null' minLength: 1 retains_outside_legal_counsel: type: - string - number - integer - 'null' minLength: 1 commission_payment_method: type: - string - number - integer - 'null' commission_payment_channels: type: - string - number - integer - 'null' commission_payment_countries: type: - string - number - integer - 'null' compensation_plan_file_url: type: - string - number - integer - 'null' compensation_plan_file_name: type: - string - number - integer - 'null' recruiter_commission_for_recruiting: type: - string - number - integer - 'null' all_distributors_can_profit: type: - string - number - integer - 'null' provides_average_compensation_report: type: - string - number - integer - 'null' income_disclosure_statement_file_url: type: - string - number - integer - 'null' income_disclosure_statement_file_name: type: - string - number - integer - 'null' distributor_retention_turnover_rates: type: - string - number - integer - 'null' distributor_identification_requirements: type: - string - number - integer - 'null' distributor_pii_collected: type: - string - number - integer - 'null' distributor_due_diligence: type: - string - number - integer - 'null' distributor_country_restrictions: type: - string - number - integer - 'null' distributor_decline_termination_reasons: type: - string - number - integer - 'null' distributor_cross_border_sales: type: - string - number - integer - 'null' distributor_training_description: type: - string - number - integer - 'null' investigations_description: type: - string - number - integer - 'null' minLength: 1 negative_media_events: type: - string - number - integer - 'null' minLength: 1 bbb_rating: type: - string - number - integer - 'null' minLength: 1 trustpilot_rating: type: - string - number - integer - 'null' minLength: 1 fulfillment_agreement_file_url: type: - string - number - integer - 'null' fulfillment_agreement_file_name: type: - string - number - integer - 'null' manufacturing_agreement_file_url: type: - string - number - integer - 'null' manufacturing_agreement_file_name: type: - string - number - integer - 'null' financials_audited: type: - boolean - 'null' financials: type: - array - 'null' items: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' projected_annual_sales_volume: type: - number - string - integer - 'null' average_order_value: type: - number - string - integer - 'null' cit_share_percentage: type: - number - string - integer - 'null' mit_share_percentage: type: - number - string - integer - 'null' terms_and_conditions: type: - object - 'null' properties: link: type: - string - number - integer - 'null' file_name: type: - string - number - integer - 'null' file_url: type: - string - number - integer - 'null' refund_or_return_policy: type: - object - 'null' properties: link: type: - string - number - integer - 'null' file_name: type: - string - number - integer - 'null' file_url: type: - string - number - integer - 'null' privacy_policy: type: - object - 'null' properties: link: type: - string - number - integer - 'null' file_name: type: - string - number - integer - 'null' file_url: type: - string - number - integer - 'null' distributor_policies_file_url: type: - string - number - integer - 'null' distributor_policies_file_name: type: - string - number - integer - 'null' sample_distributor_agreement_file_url: type: - string - number - integer - 'null' sample_distributor_agreement_file_name: type: - string - number - integer - 'null' business_opportunity_disclosures_file_url: type: - string - number - integer - 'null' business_opportunity_disclosures_file_name: type: - string - number - integer - 'null' owners_principals_list: type: - string - number - integer - 'null' sells_health_supplements: type: - boolean - 'null' is_product_manufacturer: type: - string - number - integer - 'null' marketing_methods_description: type: - string - number - integer - 'null' cancellation_methods_description: type: - string - number - integer - 'null' scientific_studies_description: type: - string - number - integer - 'null' contains_kratom: type: - boolean - 'null' kratom_product_names: type: - string - number - integer - 'null' contains_ephedra: type: - boolean - 'null' ephedra_product_names: type: - string - number - integer - 'null' contains_cannabis: type: - boolean - 'null' cannabis_product_names: type: - string - number - integer - 'null' contains_cbd: type: - boolean - 'null' cbd_product_names: type: - string - number - integer - 'null' contains_aristolochia: type: - boolean - 'null' aristolochia_product_names: type: - string - number - integer - 'null' contains_germanium: type: - boolean - 'null' germanium_product_names: type: - string - number - integer - 'null' contains_none_listed: type: - boolean - 'null' claims_cancer_treatment: type: - boolean - 'null' cancer_treatment_products: type: - string - number - integer - 'null' claims_impotency_treatment: type: - boolean - 'null' impotency_treatment_products: type: - string - number - integer - 'null' claims_alzheimers_treatment: type: - boolean - 'null' alzheimers_treatment_products: type: - string - number - integer - 'null' claims_memory_loss_treatment: type: - boolean - 'null' memory_loss_treatment_products: type: - string - number - integer - 'null' claims_no_diseases: type: - boolean - 'null' health_product_lawsuit_history: type: - string - number - integer - 'null' product_service_description: type: - string - number - integer - 'null' revenue_from_recruiting_percentage: type: - string - number - integer - 'null' revenue_from_website_percentage: type: - string - number - integer - 'null' retail_sales_outside_downline_percentage: type: - string - number - integer - 'null' compliance_monitoring_processes: type: - string - number - integer - 'null' signup_fees_description: type: - string - number - integer - 'null' training_types_description: type: - string - number - integer - 'null' purchase_requirements_description: type: - string - number - integer - 'null' ftc_compliance_description: type: - string - number - integer - 'null' terms_and_conditions_info: type: - object - 'null' properties: terms_and_conditions_agreed: type: - boolean - 'null' terms_and_conditions_agreed_at: type: - string - number - integer - 'null' format: time terms_and_conditions_agreed_by: type: - integer - string - number - 'null' OnboardingCompany: description: Onboarding company summary returned by setup actions. type: - object - 'null' properties: onboarding_info_version: description: >- Revision of the company's onboarding info. Send it back on the next update to have a save built on a superseded revision refused with 409 rather than overwriting concurrent edits. type: integer additionalProperties: $ref: '#/components/schemas/JsonValue' OnboardingMeta: type: object required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string format: date-time additionalProperties: $ref: '#/components/schemas/JsonValue' UnauthorizedResponse: type: object properties: message: type: string required: - message StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/OnboardingMeta' additionalProperties: $ref: '#/components/schemas/JsonValue' JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.