Patient use case

Guest Invite

Create a guest invite link to a video call. The patient SSOs in, creates an intake and walk-in visit, then uses the visit code to generate a shareable invite link.

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: Create intake object

   POST /intakes · auth: User Token

   Create an intake data object to capture the reason for visit. Uses the patient's access token from Step 1.

   headers:

   Field	Required	Description
   X-ApiToken	yes	User access token from SSO response
   X-AccountCode	yes	Account code

   bodyFields:

   Field	Required	Description
   type	yes	Intake type (1 = standard)
   room_code	yes	Room code for the waiting room
   reason_for_visit	no	Reason for visit / chief complaint

3. Step 3: Create a walk-in visit

   POST /visits/add_walkin · auth: User Token

   Create a walk-in visit. The response includes data.code — a unique visit code used for the invite link.

   headers:

   Field	Required	Description
   X-ApiToken	yes	User access token from SSO response
   X-AccountCode	yes	Account code

   bodyFields:

   Field	Required	Description
   provider_id	yes	VSee member ID of the provider handling this visit (auto-fills from stored Provider Member ID)
   intake_id	yes	Intake ID from Step 2
   room_code	yes	Room code

4. Step 4: Build guest invite link

   Redirect to https://{your_clinic}.vseepreview.com/visits/join/{visit_code}

   Use data.code from the visit response (not data.id) to build the invite link. No authentication is required to join via this link.