Get Embedded SDK token | Kota Developer Products Documentation

Retrieve a token to authenticate an employer or employee with the Kota Embedded SDK.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Request

This endpoint expects an object.

employer_idstringRequiredformat: "er_.+"

employee_idstring or nullOptionalformat: "ee_.+"

external_customer_idstring or nullOptional

A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is required for Employer Session tokens for EoR platforms.

Response

tokenstring

expirydatetime

Errors

400

Bad Request Error

404

Not Found Error

Authorization header using the Bearer scheme

This endpoint expects an object.

$	curl -X POST https://test.api.kota.io/embed/sessions \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"employer_id": "er_9f8b7c6d5e4a3b2c1d0e9f8a7b6c5d4e"
>	}'

$	curl -X POST https://test.api.kota.io/embed/sessions \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"employer_id": "er_9f8b7c6d5e4a3b2c1d0e9f8a7b6c5d4e"
>	}'

1	{
2	"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbnYiOiJwcm9kIiwiZXhwIjoxNzA5MjQ4MDAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
3	"expiry": "2024-12-01T00:00:00Z"
4	}