Mobile use case

Member SSO

Get an SSO token and inject it into your mobile app. Your backend calls SSO, receives the token, and passes it to the mobile app to open a WebView.

Steps

  1. Step 1: Obtain patient access token

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

    Your backend calls SSO with ?fields=vsee. Response includes the SSO token and VSee credentials.

    headers:

    FieldRequiredDescription
    X-ApiKeyyesAPI Key
    X-ApiSecretyesAPI Secret
    X-AccountCodeyesAccount code

    queryParams:

    FieldRequiredDescription
    fieldsnoSet to 'vsee' to include VSee ID and token

    bodyFields:

    FieldRequiredDescription
    first_nameyesPatient's first name
    last_nameyesPatient's last name
    typeyesUser type: 200 = Patient
    emailnoPatient email address
    codeyesUnique patient identifier on your end (max 128 chars)
  2. Step 2: Pass token to mobile app

    Send the SSO token (data.token.token) from the response to your mobile app via your existing auth flow or internal API.

  3. Step 3: Open WebView with token

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

    In the mobile app, open a WebView pointing to the auth URL.