Skip to main content
PATCH
/
api
/
v1
/
onboarding
/
setup
cURL
curl -sS -X PATCH "$FLUIDE_BASE_URL/api/v1/onboarding/setup" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

Body

application/json
​
onboardingPersona
enum<string>
Available options:
business_owner,
partner,
service_partner,
virtual_manager,
compliance_expert,
eso,
capital_allocator
​
businessType
enum<string>
Available options:
SME,
STARTUP,
NGO,
MFI,
CORPORATE,
COOPERATIVE
​
partner
object
​
eso
object
​
capitalAllocator
object
​
firmVerification
object
​
businessRegistration
object
​
partnerCompliance
object
​
legal
object
​
regionWorkspace
object
​
billing
object
​
invites
object
​
personalInfo
object
​
organizationStructure
object

Organization-wide department names and role labels (merged into setupData).

​
wizardStepCursor
number

Optional UI cursor for resume across wizard steps.

Required range: 0 <= x <= 15
​
employmentOnboardingMode
enum<string>

HR_FIRST: create HR employee then optional invite. INVITE_FIRST: store HR draft then invite; HR row created when user accepts.

Available options:
HR_FIRST,
INVITE_FIRST

Response

Patch Setup

​
success
boolean
required

Whether the request succeeded

Example:

true

​
message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

​
data
object

Endpoint-specific payload