Offboard an employer

POST

/employers/:employer_id/offboard

POST

/employers/:employer_id/offboard

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

1 {
2   "id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3   "legal_name": "Acme Corporation Ltd",
4   "legal_address": {
5     "line1": "123 Innovation Drive",
6     "city": "San Francisco",
7     "postal_code": "94107",
8     "country_code": "us",
9     "line2": null,
10     "line3": null,
11     "state": "CA"
12   },
13   "contact": {
14     "name": "Jane Doe",
15     "email": "jane.doe@acmecorp.com"
16   },
17   "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
18   "status": "offboarding",
19   "registration_number": "12345678",
20   "offboard_on": "2024-12-01T00:00:00Z",
21   "earliest_benefits_start_date": "2024-12-01",
22   "metadata": {
23     "department": "Human Resources",
24     "offboard_reason": "Company restructuring"
25   },
26   "object": "employer"
27 }

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_.+"

Response

idstringformat: "er_.+"

legal_namestring

legal_addressobject

contactobject

platform_idstringOptionalformat: "pt_.+"

statusenumOptional

registration_numberstring or nullOptional

offboard_ondatetime or nullOptional

earliest_benefits_start_datedate or nullOptional

metadatamap from strings to strings or nullOptional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters.

objectstringOptionalRead-only

The object type

Errors

400

Bad Request Error

Authentication

Path parameters

Headers

Response

Errors