POST /api/auth/login
Authenticates a user with a phone number and 4-digit PIN. Optionally accepts agroupName to prevent cross-group access and a loginType to restrict portal access by role.
Request body
The user’s phone number in Uganda format. Must match the pattern
+256XXXXXXXXX (country code followed by 9 digits).The user’s 4-digit numeric PIN. Must be exactly 4 digits (e.g.,
"1234"). No letters or special characters are accepted.The name of the group to log into. When provided, the server verifies that the user belongs to this group. Use this to prevent a user from one group accidentally or maliciously accessing another group’s portal.
Restricts login to a specific portal type. Accepted values are
"admin" or "member". Passing "admin" blocks non-admin users from reaching the admin portal.Response
A signed JWT bearer token. Include this value in the
Authorization header as Bearer <token> on all subsequent authenticated requests. The token is valid for 24 hours.true if this user created the group, false otherwise. Group creators may have elevated permissions within admin interfaces.Error responses
POST /api/auth/firebase-login
Authenticates a user using a Firebase ID token obtained from Firebase Phone Authentication on the client. If the phone number in the decoded token does not yet have an account in the specified group, a new member account is created automatically.This endpoint is rate-limited to 10 requests per minute. Implement exponential back-off on your client when retrying after a
429 response.Request body
The Firebase ID token issued by Firebase Authentication after the client completes phone verification. Obtain this token client-side using the Firebase SDK.
The name of the group the user is logging into. Must be between 2 and 100 characters. If the phone number is new, the account is created under this group.
Response
Returns the sameLoginResponse shape as POST /api/auth/login.

