API ReferenceEmployers

Offboard an employer

Immediately offboard an employer. The employer’s scheme will be terminated and all employees associated with the employer will be offboarded and have their insurance terminated. Employee offboarding cannot be cancelled if triggered via this call.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

employer_idstringRequiredformat: "er_.+"

Headers

Idempotency-KeystringOptional

Unique key to ensure idempotent requests. If the same key is used for multiple identical & successful requests, the same response will be returned. Read more here

Response

OK
idstringformat: "er_.+"
legal_namestring
legal_addressobject
contactobject
platform_idstring or nullformat: "pt_.+"
statusenum or null
Allowed values:
registration_numberstring or null
offboard_onstring or nullformat: "date-time"
earliest_benefits_start_datestring or nullformat: "date"
objectstring or null
The object type

Errors