Skip to content
Abi Global HealthAbi Global HealthAbi Docs

Create a user account

POST
/user
curl --request POST \
  --url https://example.com/user \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "uniqueId": "example", "language": "en", "physicianCountry": "example", "phone": "example", "email": "hello@example.com", "shouldNotify": true }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
uniqueId
string
language
required
string
Example
en
physicianCountry
required
string
phone

E.164 formatted phone number.

string
email
string format: email
shouldNotify
boolean
default: true

Responses

Section titled “Responses”

201

Section titled “201”

User created.

Media typeapplication/json

The Abi record representing a person who can use a configured service.

object
id
required

The unique identifier Abi assigns to the user account.

string
uniqueId

An optional identifier from the partner system.

string
firstName

The user’s first name.

string
lastName

The user’s surname.

string
email

The user’s email address.

string format: email
phone

The user’s mobile number including international dialing code (E.164).

string
dateOfBirth

The user’s date of birth.

string
gender

The user’s gender where supplied.

string
Allowed values: male female other
language
required

The language used to communicate with Abi.

string
country

The user’s nationality or country code.

string
location
required

The country where the user lives or is currently located.

string
origin
required

The country in which the user was born.

string
physicianCountry
required

The country in which responding healthcare professionals are licensed.

string
partnerName
required

The partner company recorded in Abi.

string
associatedAccounts

The permitted number of associated accounts for an enabled group-account policy.

integer
userStatus

The user’s current access status.

string
Allowed values: activeUser pendingActivation deactivatedUser
Example
{
  "id": "abi1234",
  "uniqueId": "123abc789xyz",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "janedoe@example.com",
  "phone": "+441234567890",
  "dateOfBirth": "1994-10-07",
  "gender": "male",
  "language": "en",
  "country": "it",
  "location": "es",
  "origin": "gb",
  "physicianCountry": "es",
  "partnerName": "Abi",
  "associatedAccounts": 5,
  "userStatus": "activeUser"
}