Manage users and subscriptions
An Abi user account represents one of your customers in Abi’s service. It is the shared identity used to grant access, start consultations, use Health Navigator, and open GoApp.
The user account
Section titled “The user account”Abi assigns every account an id when it is created. Use this value for Abi API operations and as the user identity in the GoApp URL. Your system can also supply a uniqueId—for example, an insurance or membership reference—to keep the connection to your own customer record.
The account holds the service-delivery context agreed for that person. This can include their language, location, country of origin, physician country, and the optional contact details required by the chosen journey. It is not intended to become a duplicate of your entire customer database.
| Product concept | How it is used |
|---|---|
Abi id |
Abi’s generated identifier for API operations and GoApp. |
uniqueId |
Your stable customer or policy reference. |
| Language | The language used for the Abi experience. |
| Physician country | The jurisdiction in which responding healthcare professionals are licensed. |
| Account status | Whether the account has current access to Abi. |
The API reference is the source of truth for field names, required values, and response schemas.
Access and subscriptions
Section titled “Access and subscriptions”A subscription represents the agreed period during which a user can access Abi and ask a medical question. It belongs to one user account and has its own identifier, start date, end date, and active or cancelled state.
- An active subscription gives the user access to the services enabled for their account.
- A subscription is active when it has not been cancelled and the current date falls within its start and end dates.
- An expired or cancelled subscription is no longer active.
- An account can have subscription history, including renewals where this has been enabled for the partner.
Identifiers
Section titled “Identifiers”idis generated by Abi. Use it for Abi API operations and in the GoApp URL.uniqueIdis an optional identifier supplied by your system. Keep it as your own customer reference.
Creating and updating a user
Section titled “Creating and updating a user”Creating a user can also create and associate a subscription from the supplied request data. Phone numbers use E.164 format. An email address is required when email notifications are part of the agreed journey.
The integration parameters language and physicianCountry configure service delivery; they are not patient-facing form fields.
Subscription behavior
Section titled “Subscription behavior”- A user needs an active subscription to access Abi.
- If no start date is supplied, the subscription starts when the user is created.
- If no end date is supplied, the contractually agreed duration applies.
- Auto-renewal creates a new subscription for the same duration unless it is cancelled before expiry.
- Deactivating a user cancels their subscriptions and removes access; creating a later subscription can reactivate the user.
Correcting user data
Section titled “Correcting user data”The public API does not expose user deletion. Use the update operation to correct account information. Contact Client Success if a notification must be resent.
Use the generated API reference for required fields, request examples, and responses.