Authentication & access endpoints
Endpoints for login, TOTP verification, and platform access requests.
POST
/v1/auth/loginStart unified login for a user or admin account.
AuthPublic
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
email | string | Account email address. | Yes |
password | string | Portal 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/verifyVerify a login challenge with a TOTP or backup code.
AuthPublic
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
challenge_token | string | Token returned by login. | Yes |
code | string | 2FA 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-requestsSubmit a request for platform access.
AuthPublic
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
name | string | Contact name. | Yes |
email | string | Business email. | Yes |
company | string | Company name. | Yes |
phone | string | Phone number. | Yes |
monthly_volume | string | Expected volume. | Yes |
message | string | Use 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"
}