API Reference

Create a Patient

post
https://patient-api.portals.care/users

Register a new patient account within an organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A Data Transfer Object (DTO) for registering a new patient user. This schema requires essential patient information to create an account.

string
required

The patient's email address. Must be a valid format and unique within the system.

string

The patient's password. It must meet security requirements, including minimum length and character complexity.

string
required

The patient's first name.

string
required

The patient's last name.

gender
object
required

The patient's gender.

string
required

The patient's phone number, with digits only. The system will format it with the country code.

string

A unique username formatted as email#organization. This field is often automatically generated by the system.

roles
array of strings

An array of roles assigned to the patient. For patient users, this is typically ['patient'].

roles
string
required

The patient's date of birth in YYYY-MM-DD format.

meta
object

Additional metadata about the patient.

number

The count of unread notifications for the patient. Defaults to 0 upon creation.

number

The unique identifier for the patient in an external Electronic Medical Record (EMR) system.

string

The identifier of the referrer, if the patient was referred by another user.

hcCard
object

An object containing the patient's health card information.

boolean

A boolean indicating whether the patient accepts marketing communications.

boolean

A boolean indicating if insurance information is available for the patient. Defaults to false.

providers
array of strings

An array of provider IDs associated with the patient.

providers
verifications
object

An object containing verification statuses, such as email or phone number verification.

string

The two-letter province or state code of the patient's primary address.

groups
array of strings

An array of group IDs the patient is a member of.

groups
Headers
string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Response

Updated 2 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago