My Account
Endpoints related to user authentication and account management.
Authenticates a user (subscriber or Admministrator) and returns an authentication result with tokens. Accepts either EmailAddress or SubscriberToken and a Password. Handles Cognito authentication and returns user profile and tokens on success.
The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.
https://demo.roamingiq.comExample: https://demo.roamingiq.comEmail address of the user (required for NSP admin login).
Subscriber token (required for subscriber login).
User password.
POST /preview/subscriberconsole/login HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"EmailAddress": "text",
"SubscriberToken": "text",
"Password": "text"
}{
"message": "text",
"AuthenticationResult": {
"AuthenticationResult": {
"AccessToken": "text",
"ExpiresIn": 1,
"IdToken": "text",
"RefreshToken": "text",
"TokenType": "text"
}
},
"Enabled": true,
"CognitoStatus": "text",
"locale": "text",
"OperatorID": "text",
"StripeCustomerID": "text",
"SubscriberManagedviaSSO": true,
"dateAddedUTC": "text",
"AdministrativeAccess": {},
"errorProcessing": true
}Refreshes the Cognito access token for a user session using a valid RefreshToken. Returns new authentication tokens if successful.
The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.
https://demo.roamingiq.comExample: https://demo.roamingiq.comThe current (possibly expired) access token.
The refresh token issued by Cognito.
POST /preview/subscriberconsole/refreshAccessToken HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"AccessToken": "text",
"RefreshToken": "text"
}{
"message": "text",
"AuthenticationResult": {
"AuthenticationResult": {
"AccessToken": "text",
"ExpiresIn": 1,
"IdToken": "text",
"RefreshToken": "text",
"TokenType": "text"
}
}
}Allows a subscriber to accept the latest Terms and Conditions by setting a new password after first login or password reset. Requires a temporary password and a new password. Updates user attributes and account status in Cognito and the system.
The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.
https://demo.roamingiq.comExample: https://demo.roamingiq.comEmail address of the user (required for email verification).
The temporary password provided to the user (required).
The new password to set (must be at least 8 characters).
POST /preview/subscriberconsole/acceptTandC HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"EmailAddress": "text",
"TemporaryPassword": "text",
"NewPassword": "text"
}{
"message": "string",
"errorProcessing": false
}Initiates the password reset process for a subscriber. If the subscriber has already accepted the Terms and Conditions, a password reset code (OTP) is generated and sent to the user's email. If the subscriber has not accepted the Terms and Conditions, a welcome email with a temporary password is sent. The API always returns a message indicating the result.
The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.
https://demo.roamingiq.comExample: https://demo.roamingiq.comEmail address of the user requesting password reset.
POST /preview/subscriberconsole/initiateResetConsolePassword HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"EmailAddress": "text"
}{
"message": "Code to reset password sent to [email protected]"
}Confirms a password reset for a subscriber by validating the OTP (reset code) and setting a new password. The new password must be between 8 and 63 characters and meet character requirements. Returns a message indicating the result.
The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.
https://demo.roamingiq.comExample: https://demo.roamingiq.comEmail address of the user resetting the password.
The one-time password (reset code) sent to the user's email.
The new password to set (8-63 valid characters).
POST /preview/subscriberconsole/confirmResetConsolePassword HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"EmailAddress": "text",
"OTP": "text",
"NewPassword": "text"
}{
"message": "Password changed for [email protected]"
}Logs out a subscriber or administrator from the console by invalidating all active sessions for the user in Cognito. Requires a valid AccessToken in the request body. On success, returns a confirmation message. On error (invalid token, user not found, or processing error), returns an error message.
The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.
https://demo.roamingiq.comExample: https://demo.roamingiq.comThe Cognito access token for the user session to be logged out.
POST /preview/subscriberconsole/logout HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"AccessToken": "text"
}{
"message": "User logged out. "
}Updates Personally Identifiable Information (PII) for a subscriber. Requires a valid AccessToken (with SubscriberToken) and the fields to update. The endpoint validates the subscriber, checks their association with the operator, and updates PII fields if valid. Returns a message indicating success or error, including details of what was updated.
The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.
https://demo.roamingiq.comExample: https://demo.roamingiq.comCognito access token for the subscriber session (must contain SubscriberToken).
Subscriber's given (first) name.
JohnSubscriber's family (last) name.
DoeSubscriber's phone number in E.164 format.
+12345678900Locale preference for the subscriber.
en_USWhether the subscriber prefers SMS contact.
trueWhether the subscriber prefers email contact.
falsePOST /preview/subscriberconsole/updatePII HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 213
{
"AccessToken": "{{Fake-AccessToken}}",
"EmailAddress": "[email protected]",
"GivenName": "John",
"FamilyName": "Doe",
"PhoneNumber.E164": "+12345678900",
"locale": "en_US",
"contactpref_sms": true,
"contactpref_email": false
}{
"message": "Updating GivenName=John. Updating FamilyName=Doe. Updating [email protected]. Updating PhoneNumber.E164=+12345678900. Updating phone_number_verified = false. PII data updated. ",
"errorProcessing": false
}Was this helpful?