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.
Path parameters
employer_id
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Idempotency-Key
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
id
legal_name
legal_address
contact
platform_id
status
Allowed values:
registration_number
offboard_on
object
The object type