Offboard an employer

POST

/employers/:employer_id/offboard

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_idstringRequired

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

idstringformat: "er_.+"

legal_namestring

legal_addressobject

contactobject

platform_idstringOptionalformat: "pt_.+"

statusenumOptional

Allowed values: pendingactiveoffboardinginactiverestricted

registration_numberstringOptional

offboard_ondatetimeOptional

objectstringOptional

The object type

Built with

1	{
2	"id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"legal_name": "legal_name",
4	"legal_address": {
5	"line1": "line1",
6	"city": "city",
7	"postal_code": "postal_code",
8	"country_code": "af",
9	"line2": "line2",
10	"line3": "line3",
11	"state": "state"
12	},
13	"contact": {
14	"name": "name",
15	"email": "email"
16	},
17	"platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
18	"status": "pending",
19	"registration_number": "registration_number",
20	"offboard_on": "2024-01-15T09:30:00Z",
21	"object": "object"
22	}

1	curl -X POST https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/offboard \
2	-H "Authorization: Bearer <apiKey>"