Skip to main content
POST
Onboard

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Body

application/json
requestId
string
required
type
enum<string>
required
Available options:
contractor,
supplier
addressLine1
string
required
mainContact
object
required
sendInvite
boolean
required
insuranceExpiresOn
string
required
paymentTerms
enum<string>
required
Available options:
on_completion,
14_days,
30_days,
60_days
tradingName
string · null · null
registrationNumber
string · null · null
addressTown
string · null · null
addressPostcode
string · null · null
contractor
object | null
supplier
object | null
vatNumber
string · null · null
invoiceEmail
string · null · null

Response

Success

company
object
required
primaryContactId
string
required
contractor
object | null
required
insuranceCredentialId
string | null
required
invite
object
required
replayed
boolean
required