Get Embedded SDK token

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

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
employer_idstringRequiredformat: "er_.+"
employee_idstringOptionalformat: "ee_.+"
external_customer_idstringOptional

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

OK

tokenstring
expirystringformat: "date-time"

Errors