Onboarding Info
/
Get company onboarding info

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

Download OpenAPI description
swagger.json
swagger.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Menus

Operations

Metafield Definitions

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Get company onboarding info

Request

Path
company_idintegerrequired
Example: 1
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/onboarding_info' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

onboarding info retrieved

Bodyapplication/json
companyobjectrequired
company.​idintegerrequired
Example: 1
company.​onboarding_infoobjectrequired
company.​onboarding_info.​beneficial_individual_ownerboolean or null
Example: true
company.​onboarding_info.​user_is_ownerboolean or null
Example: true
company.​onboarding_info.​beneficial_business_ownerboolean or null
Example: false
company.​onboarding_info.​other_legal_entitiesboolean or null
Example: false
company.​onboarding_info.​user_has_authorityboolean or null
Example: true
company.​onboarding_info.​user_is_signatoryboolean or null
Example: true
company.​onboarding_info.​has_paypal_business_accountboolean or null
Example: false
company.​onboarding_info.​user_is_primary_decision_makerboolean or null
Example: true
company.​onboarding_info.​business_structure_complexitystring or null
Example: "simple"
company.​onboarding_info.​operates_internationallyboolean or null
Example: false
company.​onboarding_info.​kyc_flow_current_stepstring or null
Example: "business_info"
company.​onboarding_info.​kyc_flow_completed_stepsstring or null
Example: "identity_verification"
company.​onboarding_info.​paypal_connectedboolean or null
Example: false
company.​onboarding_info.​paypal_business_info_prefilledboolean or null
Example: false
company.​onboarding_info.​onboarding_stepsobject
company.​onboarding_info.​data_migrationobject
metaobjectrequired
meta.​request_idstringrequired
Example: "f342713b-79c5-487f-b5eb-30b174e7b6d8"
meta.​timestampstringrequired
Example: "2025-08-24T17:39:20Z"
Response
application/json
{
  "company": {
    "id": 1,
    "onboarding_info": { … }
  },
  "meta": {
    "request_id": "f342713b-79c5-487f-b5eb-30b174e7b6d8",
    "timestamp": "2025-08-24T17:39:20Z"
  }
}

Update company onboarding info

Request

Path
company_idintegerrequired
Example: 1
Bodyapplication/json
onboarding_infoobjectrequired
onboarding_info.​beneficial_individual_ownerboolean

Whether the user is a beneficial individual owner

Example: true
onboarding_info.​user_is_ownerboolean

Whether the user is an owner

Example: true
onboarding_info.​beneficial_business_ownerboolean

Whether there are beneficial business owners

Example: false
onboarding_info.​other_legal_entitiesboolean

Whether there are other legal entities

Example: false
onboarding_info.​user_has_authorityboolean

Whether the user has authority to act

Example: true
onboarding_info.​user_is_signatoryboolean

Whether the user is a signatory

Example: true
onboarding_info.​has_paypal_business_accountboolean

Whether the company has a PayPal business account

Example: false
onboarding_info.​user_is_primary_decision_makerboolean

Whether the user is the primary decision maker

Example: true
onboarding_info.​business_structure_complexitystring

Complexity of the business structure

Example: "simple"
onboarding_info.​operates_internationallyboolean

Whether the company operates internationally

Example: false
onboarding_info.​kyc_flow_current_stepstring

Current step in the KYC flow

Example: "business_info"
onboarding_info.​kyc_flow_completed_stepsstring

Completed steps in the KYC flow

Example: "identity_verification"
onboarding_info.​paypal_connectedboolean

Whether PayPal is connected

Example: false
onboarding_info.​paypal_business_info_prefilledboolean

Whether PayPal business info is prefilled

Example: false
onboarding_info.​onboarding_stepsobject
onboarding_info.​data_migrationobject
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/onboarding_info' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "onboarding_info": {
      "beneficial_individual_owner": true,
      "user_is_owner": true,
      "beneficial_business_owner": false,
      "other_legal_entities": false,
      "user_has_authority": true,
      "user_is_signatory": true,
      "has_paypal_business_account": false,
      "user_is_primary_decision_maker": true,
      "business_structure_complexity": "simple",
      "operates_internationally": false,
      "kyc_flow_current_step": "business_info",
      "kyc_flow_completed_steps": "identity_verification",
      "paypal_connected": false,
      "paypal_business_info_prefilled": false,
      "onboarding_steps": {
        "basic_info": 50,
        "paypal_connect": 80,
        "business_info": 30,
        "legal_entities": 100,
        "bank_accounts_i": 30,
        "bank_accounts_ii": 100,
        "personal_info": 100,
        "relevant_persons": 100,
        "countries": 100,
        "alternate_payment_methods": 100,
        "data_migration": 100,
        "agreements_and_policies": 100
      },
      "data_migration": {
        "active": true,
        "tokenization_provider": "Stripe",
        "estimated_token_count": 1000
      }
    }
  }'

Responses

onboarding info updated

Bodyapplication/json
companyobjectrequired
company.​idintegerrequired
Example: 1
company.​onboarding_infoobjectrequired
company.​onboarding_info.​beneficial_individual_ownerboolean or null
Example: true
company.​onboarding_info.​user_is_ownerboolean or null
Example: true
company.​onboarding_info.​beneficial_business_ownerboolean or null
Example: false
company.​onboarding_info.​other_legal_entitiesboolean or null
Example: false
company.​onboarding_info.​user_has_authorityboolean or null
Example: true
company.​onboarding_info.​user_is_signatoryboolean or null
Example: true
company.​onboarding_info.​has_paypal_business_accountboolean or null
Example: false
company.​onboarding_info.​user_is_primary_decision_makerboolean or null
Example: true
company.​onboarding_info.​business_structure_complexitystring or null
Example: "simple"
company.​onboarding_info.​operates_internationallyboolean or null
Example: false
company.​onboarding_info.​kyc_flow_current_stepstring or null
Example: "business_info"
company.​onboarding_info.​kyc_flow_completed_stepsstring or null
Example: "identity_verification"
company.​onboarding_info.​paypal_connectedboolean or null
Example: false
company.​onboarding_info.​paypal_business_info_prefilledboolean or null
Example: false
company.​onboarding_info.​onboarding_stepsobject
company.​onboarding_info.​data_migrationobject
metaobjectrequired
meta.​request_idstringrequired
Example: "f342713b-79c5-487f-b5eb-30b174e7b6d8"
meta.​timestampstringrequired
Example: "2025-08-24T17:39:20Z"
Response
application/json
{
  "company": {
    "id": 1,
    "onboarding_info": { … }
  },
  "meta": {
    "request_id": "f342713b-79c5-487f-b5eb-30b174e7b6d8",
    "timestamp": "2025-08-24T17:39:20Z"
  }
}

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Search

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations