v1

latestOpenAPI 3.0.0BSD-3-Clause2026-07-146135105.7 KB

account

Create Account Session

Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.

post/account/sessions

Request body

emailstring required

User email.

passwordstring required

User password. Must be between 6 to 32 chars.

Response

Session

$idstring required

Session ID.

clientCodestring required

Client code name. View list of available options.

clientEnginestring required

Client engine name.

clientEngineVersionstring required

Client engine name.

clientNamestring required

Client name.

clientTypestring required

Client type.

clientVersionstring required

Client version.

countryCodestring required

Country two-character ISO 3166-1 alpha code.

countryNamestring required

Country name.

currentboolean required

Returns true if this the current user session.

deviceBrandstring required

Device brand name.

deviceModelstring required

Device model name.

deviceNamestring required

Device name.

expireinteger required

Session expiration date in Unix timestamp.

ipstring required

IP in use when the session was created.

osCodestring required

Operating system code name. View list of available options.

osNamestring required

Operating system name.

osVersionstring required

Operating system version.

providerstring required

Session Provider.

providerTokenstring required

Session Provider Token.

providerUidstring required

Session Provider User ID.

userIdstring required

User ID.