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_idstringRequiredformat: "er_.+"

Response

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"

objectstring or null

The object type

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

Path parameters

Headers

Response

Errors

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