Hosted Sessions

Get One-off Hosted Session Link

Retrieve a hosted link to authenticate an employee with the Kota Hosted. This link is valid for a single use and expires after 60 minutes. The link opens on your platform's hosted domain. It opens on Kota's default hosted domain instead when your platform has no hosted configuration, or when the employee's metadata has is_whitelabel set to "true".

post/hosted/sessions

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/hosted/sessions
  • Auth
    HTTP bearer

Request body

employer_idstring required
employee_idstring required

Example request

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

Response

OK

linkstring required
expirystring date-time required

Example response

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

Changes

No recorded changes to this operation across all 29 revisions of this API.