Authentication & access endpoints

Endpoints for login, TOTP verification, and platform access requests.

POST/v1/auth/login

Start unified login for a user or admin account.

AuthPublic
Parameters
NameTypeDescriptionRequired
emailstringAccount email address.Yes
passwordstringPortal or admin password.Yes
Request samplePOST /v1/auth/login
{
  "email": "[email protected]",
  "password": "••••••••••"
}
Response sample200 OK
{
  "account_type": "user",
  "challenge_token": "challenge_token",
  "totp_required": true
}
POST/v1/auth/verify

Verify a login challenge with a TOTP or backup code.

AuthPublic
Parameters
NameTypeDescriptionRequired
challenge_tokenstringToken returned by login.Yes
codestring2FA or backup code.Yes
Request samplePOST /v1/auth/verify
{
  "challenge_token": "challenge_token",
  "code": "123456"
}
Response sample200 OK
{
  "account_type": "user",
  "token": "portal_session_token"
}
POST/v1/access-requests

Submit a request for platform access.

AuthPublic
Parameters
NameTypeDescriptionRequired
namestringContact name.Yes
emailstringBusiness email.Yes
companystringCompany name.Yes
phonestringPhone number.Yes
monthly_volumestringExpected volume.Yes
messagestringUse case details.Yes
Request samplePOST /v1/access-requests
{
  "name": "Client Name",
  "email": "[email protected]",
  "company": "Example Co",
  "monthly_volume": "10k-50k",
  "message": "OTP and alerts"
}
Response sample200 OK
{
  "id": "req_123",
  "status": "new"
}