Patient use case

Patient Dashboard

Log patient in and take them to VSee Clinic's patient dashboard where they can manage appointments, join video calls, and view visit history.

Steps

1. Step 1: Obtain patient access token

   POST /users/sso · auth: API Key + Secret

   Call SSO with patient details (type=200). Use ?fields=vsee to include VSee ID and token in the response.

   headers:

   Field	Required	Description
   X-ApiKey	yes	API Key
   X-ApiSecret	yes	API Secret
   X-AccountCode	yes	Account code

   queryParams:

   Field	Required	Description
   fields	no	Set to 'vsee' to include VSee ID and token

   bodyFields:

   Field	Required	Description
   first_name	yes	Patient's first name
   last_name	yes	Patient's last name
   type	yes	User type: 200 = Patient
   email	no	Patient email address
   code	yes	Unique patient identifier on your end (max 128 chars)

2. Step 2: Redirect to patient dashboard

   Redirect to https://{your_clinic}.vseepreview.com/auth?sso_token={sso_token}&next=/u/{room_slug}

   Redirect the patient's browser to the VSee Clinic dashboard.