Skip to main content
POST
Add an organisation

Authorizations

X-Auth-Token
string
header
required

FlowPayroll JWT (raw token, no Bearer prefix)

Headers

Idempotency-Key
string

Your own key for this create, so a retry after a lost response finds what the first attempt made instead of making a second one. Any unique string up to 255 characters; a UUID is the usual choice. Send the same value on every retry of the same request, and a new value for a new one — reusing a key for a different body answers 409 idempotency_key_reused. Keys are remembered for 24 hours. Optional, and a request without one simply has no replay protection.

Maximum string length: 255

Body

application/json

Adds an organisation to your account. Only legalName is required.

Required. The registered legal name.

tradingName
string | null

The trading name, if it differs from the legal name.

organisationType
enum<string> | null

One of Branch, Franchise, Independent, Parent or Subsidiary.

Available options:
Branch,
Franchise,
Independent,
Parent,
Subsidiary
businessType
enum<string> | null

One of Charity, LimitedCompany, LimitedLiabilityPartnership, Partnership, PublicSector or SoleTrader.

Available options:
Charity,
LimitedCompany,
LimitedLiabilityPartnership,
Partnership,
PublicSector,
SoleTrader
companyRegistrationNumber
string | null

The Companies House registration number.

registeredOfficeAddress
object

A postal address.

correspondenceAddress
object

A postal address.

primaryContactDetails
object

A named contact.

companyContactDetails
object

A named contact.

Response

OK

message
object
content
object
validationIssues
object[] | null