Versions Compared

Old Version 18

changes.mady.by.user An Nguyen

Saved on

compared with

New Version 19

changes.mady.by.user Anton Tolkachiov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
"vsee": {
    "id": "ccpreview+606ce3e353c8411a8e7b52c664457b1f",
    "token": "78fc497ff743d2b51050d9102acabe63"
}

POST Parameters

Parameter

Type

Description

first_name

String

Required

last_name

String

Required

dob

String

Optional

YYYY-MM-DD format

type

Integer

200: Member, 400: Provider, 600: Guest User

code

String

Required if type is 200 or 400 / Max length: 128 character
code is a unique user identifier on your end. VSee will store the code for this user record and next time you call SSO, we will return you the same existing user.

email

String

Optional

username

String

Optional - system will generate one as fallback

disable_emails

Integer

Optional - set to 1 - if you want user to disable all email notification

POST Parameters required in order to be able to e-prescribe for this user:

Parameter

Type

Description

first_name

String

Required

last_name

String

Required

dob

String

Required

YYYY-MM-DD format

type

Integer

200: Member

code

String

Required

Max length: 128 character
code is a unique user identifier on your end. VSee will store the code for this user record and next time you call SSO, we will return you the same existing user.email

gender

String

Required

male / female

street_addr

String

Required

city

Integer

Required

state

String

Required

Two-Letter State Abbreviation

zip

String

OptionalRequired

usernamephone

String

Optional - system will generate one as fallback

disable_emails

Integer

Optional - set to 1 - if you want user to disable all email notification

Required

Response

Note: you can use the data.token.token return here to redirect user from your portal to VSee Clinic portal, please see Workflows section.

...

GET /me
Status
colourYellow
titleV3

Retrieve the current user profile

Parameters

Parameter

Type

Description

user_photo_size

String

(optional) User photo dimensions in {W}x{H} format. Example: 320x240.

...

POST /users/logout
Status
colourYellow
titleV3

Log the current user session out corresponding to the supplied tokens. The supplied tokens will be destroyed.

Parameters

Parameter

Type

Description

tokens

Array

Array of tokens to be destroyed, e.g ['token1','token2'] or string 'token1,token2'

...

POST /tokens/refresh
Status
colourYellow
titleV3

Use refresh token to generate a new access token. New refresh token is also returned for the next refresh.

Parameters

Parameter

Type

Description

refresh_token

String

...

POST /users/reset_password
Status
colourYellow
titleV3

System will send reset password email to the email supplied if valid

Parameters

Parameter

Type

Description

email

String

Valid email to send reset password email

...