v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB

Session

Create a session

Creates a new session.

post/v3/sessions

Request body

Example request

{
  "identifiers": {
    "email_address": "joe.blow@company.com"
  },
  "validators": {
    "password": "mysecurepassword123"
  }
}

Response

tenantIdstring

subTenantIdstring

suppliedboolean

expiryDatestring

startDatestring

authenticatedboolean

state'anonymous' | 'recognised' | 'partially_registered' | 'authenticated'

devicestring

browserstring

osstring

citystring

geoStatestring

deviceNamestring

countrystring

ISO-3166-2 country code

session_idstring

user_idstring

Example response

{
  "tenantId": "company",
  "subTenantId": "company|demo",
  "expiryDate": "2025-02-08 14:29 PM UTC",
  "startDate": "2024-02-08 14:29 PM UTC",
  "authenticated": true,
  "state": "authenticated",
  "device": "pc",
  "browser": "Chrome",
  "os": "Mac OSX",
  "city": "London",
  "geoState": "London",
  "deviceName": "Apple Macintosh",
  "country": "GB",
  "session_id": "26a73b7a-f7d0-48d8-85dd-a04b07313895",
  "user_id": "UU0123456789ABCD"
}