POST
Create Organization

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Headers

X-Acting-User
string | null

The person acting through the access credential, recorded as created_by of what the request writes. Audit only: access is checked on the credential.

Required string length: 1 - 255

Body

application/json

Creating an organization: the hub, valid_from, core, and any other satellites. Each satellite sent starts on [valid_from, 9999-12-31). One not sent is not created: it reads as null until a PUT writes it.

core
GBOrganizationCore · object
required
valid_from
string<date>
required

The first day every satellite's data is valid at

address
GBOrganizationAddress · object
bank
GBOrganizationBank · object
contact
GBOrganizationContact · object
external_ref
string

The integrator's own stable key, unique within the hub's parent: the organization for an employee, the access credential for an organization. Generated when absent.

Required string length: 1 - 255
insurance
GBOrganizationInsurance · object
tax
GBOrganizationTax · object

Response

Successful Response

The organization with every satellite as it reads on one date. A satellite never written, or with no slice on an explicit date, is null.

client_id
string
required
read-only
country_code
string
required
read-only
Allowed value: "GB"
created_at
string<date-time>
required
read-only
created_by
string
required
read-only

Who created the hub: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

deleted_at
string<date-time> | null
required

When the hub was closed

external_ref
string | null
required
id
string
required
status
GBOrganizationStatus · object
required

The read-only status satellite. It carries no fields; it exists so that every organization read has a status object.

address
GBOrganizationAddressSatellite · object | null
bank
GBOrganizationBankSatellite · object | null
contact
GBOrganizationContactSatellite · object | null
core
GBOrganizationCoreSatellite · object | null
insurance
GBOrganizationInsuranceSatellite · object | null
tax
GBOrganizationTaxSatellite · object | null