Skip to content
On this page

Business Module

Business is an extension of the Onboarding Module Hub package (ext-business.sql). It ALTERs users with a business profile (is_business, biz_*) — no new tables.

Install with onboarding target: "all" (or the business component after core).

Ownership (Onboarding family)

ConcernWriteRead
Business profilePUT /auth/user/me or POST .../onboarding/completeGET /auth/user/me
Acquisition / team sizecomplete onlynever on GET
Privacy GDPR/CCPA/auth/user/me/privacy*GET me + GET privacy

Business updates are not on the Privacy routes.

Friendly rule

  1. Install onboarding + ext-business via Module Hub.
  2. First-run wizard may set biz fields via POST /auth/user/me/onboarding/complete.
  3. After that, prefer PUT /auth/user/me for is_business / biz_* (incl. biz_postal_code).
  4. Profile GET returns biz fields when columns exist.

Columns (ext-business.sql)

ColumnNotes
is_businessPrimary B2B flag
biz_nameCompany / organization
biz_countryISO alpha-2
biz_stateState / province (free text)
biz_positionRole / title
biz_postal_codePostal/ZIP or hyphenated range, max 32

Admin analytics

MethodPathNotes
GET/auth/admin/analytics/acquisitionBreakdown by channel/source
GET/auth/admin/analytics/acquisition/funnelPer-source verified/converted
GET/auth/users?is_business=&biz_country=&privacy_region=Admin list filters
PATCH/auth/admin/users/:id/privacyAdmin privacy override

See Admin API and Onboarding operations.

Docs