Initiate Prefilled Onboarding

POST/onboarding

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

type*string

The value is normalized before matching, so any casing that maps onto a listed value is accepted.

Value in

"SAAS"
"ECOMMERCE"
"MARKETPLACE"
"ADVERTISING"
"SERVICES"
"ENTERPRISE"
"FINTECH"
"FINTECH_CRYPTO"
"VIRTUAL_GOODS"
"CONSUMER"
"NOT_SURE"
"OTHER"
"AGRICULTURE_AND_FARMING"
"CONSTRUCTION"
"HEALTHCARE"
"HOME_SERVICES"
"LEGAL"
"MANUFACTURING"
"MEDIA_AND_ENTERTAINMENT"
"PROFESSIONAL_SERVICES"
"RETAIL"
"REAL_ESTATE"
"RESTAURANT"
"TRANSPORTATION"
"WHOLESALE_TRADE"

timeZone*string

Length1 <= length

currentUserRole*string

Value in

"Founder"
"CompanyEmployee"
"OutsourcedAccountantOrCFO"

orgType*string

Value in

"CCorporation"
"LLC"
"Partnership"
"SCorporation"
"SoleProprietorship"

revenueModel?string

Value in

"AnnualSubscription"
"MonthlySubscription"
"MultipleRevenueModels"
"NotSure"
"PreRevenue"
"ServiceBased"
"TransactionBased"
"UsageBased"
"Subscription"
"AddOns"
"TransactionBasedPhysical"
"TransactionBasedOther"
"Contracts"
"HourlyBilling"
"Marketplace"
"Commission"

hasHistoricalData?boolean

phoneNumber?string

connectionInfo?

Response Body

`application/json`

curl -X POST "https://example.com/onboarding" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "SAAS",    "timeZone": "string",    "currentUserRole": "Founder",    "orgType": "CCorporation"  }'

{  "url": "string"}

Initiate Prefilled Onboarding

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Request Body

Response Body

`application/json`