Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Embed Sessions

Get Embedded SDK token

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

post/embed/sessions

Request body

employer_idstring required
employee_idstring nullable
external_customer_idstring nullable

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.

Example request

{
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a"
}

Response

OK

tokenstring required
expirystring date-time required

Example response

{
  "expiry": "2024-12-01T00:00:00Z"
}