Create an employer

POST

/employers

Creates an employer.

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

Request

This endpoint expects an object.

legal_namestringRequired

legal_addressobjectRequired

contactobjectRequired

registration_numberstringOptional

Response

idstringformat: "er_.+"

legal_namestring

legal_addressobject

contactobject

platform_idstringOptionalformat: "pt_.+"

statusenumOptional

Allowed values: pendingactiveoffboardinginactiverestricted

registration_numberstringOptional

offboard_ondatetimeOptional

objectstringOptional

The object type

POST

1 curl -X POST https://test.api.kota.io/employers \
2      -H "Authorization: Bearer <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "legal_name": "legal_name",
6   "legal_address": {
7     "line1": "line1",
8     "city": "city",
9     "postal_code": "postal_code",
10     "country_code": "af"
11   },
12   "contact": {
13     "name": "name",
14     "email": "email"
15   }
16 }'

200Successful

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 }

Built with

1	curl -X POST https://test.api.kota.io/employers \
2	-H "Authorization: Bearer <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"legal_name": "legal_name",
6	"legal_address": {
7	"line1": "line1",
8	"city": "city",
9	"postal_code": "postal_code",
10	"country_code": "af"
11	},
12	"contact": {
13	"name": "name",
14	"email": "email"
15	}
16	}'

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	}