---
title: "Connect Password Provider"
method: POST
path: "/v2/link/provider/password/{provider}"
tags: ["link"]
---

# Connect Password Provider

`POST /v2/link/provider/password/{provider}`

This connects auth providers that are password based.

## Path parameters

- `provider` 'whoop' | 'renpho' | 'peloton' | 'zwift' | 'eight_sleep' | 'beurer_api' | 'dexcom' | 'hammerhead' | 'my_fitness_pal' | 'kardia' | 'abbott_libreview' | 'tandem_source', required — ℹ️ This enum is non-exhaustive.

## Headers

- `x-vital-link-token` string, nullable

## Request body

- IndividualProviderData
  - `username` string, required — Username for provider
  - `password` string, required — Password for provider
  - `region` 'us' | 'eu' | 'de' | 'fr' | 'ca' | 'br' | 'ar' | 'cl' | 'co' | 'mx' | 'gb' | 'ie' | 'au' | 'nz' | 'nl' | 'at' | 'be' | 'bh' | 'ch' | 'cz' | 'dk' | 'eg' | 'es' | 'fi' | 'gr' | 'hr' | 'il' | 'it' | 'jo' | 'kw' | 'lb' | 'lu' | 'no' | 'om' | 'pl' | 'pt' | 'qa' | 'sa' | 'se' | 'si' | 'sk' | 'tr' | 'za' | 'in' | 'sg' | 'hk' | 'kr' | 'ph' | 'tw' — ℹ️ This enum is non-exhaustive.

## Response `200`

Successful Response

- ProviderLinkResponse
  - `state` 'success' | 'error' | 'pending_provider_mfa', required — ℹ️ This enum is non-exhaustive.
  - `redirect_url` string, nullable — The redirect URL you supplied when creating the Link Token (via `POST /v2/link/token`).
  - `error_type` 'invalid_token' | 'token_expired' | 'token_not_validated' | 'token_consumed' | 'provider_credential_error' | 'provider_password_expired' | 'provider_api_error' | 'unsupported_region' | 'duplicate_connection' | 'required_scopes_not_granted' | 'incorrect_mfa_code' | 'user_cancelled', nullable — The Link Error Type. This field is populated only when state is `error`. ℹ️ This enum is non-exhaustive.
  - `error` string, nullable — A developer-readable debug description of the Link Error. This field is populated only when state is `error`.
  - `provider_mfa` ProviderMFARequest
    - `method` 'sms' | 'email', required — The MFA method requested by the password provider to complete authentication. ℹ️ This enum is non-exhaustive.
    - `hint` string, required — The MFA hint provided by the password provider, e.g., the redacted phone number.
  - `provider` 'whoop' | 'renpho' | 'peloton' | 'zwift' | 'eight_sleep' | 'beurer_api' | 'dexcom' | 'hammerhead' | 'my_fitness_pal' | 'kardia' | 'abbott_libreview' | 'tandem_source', required — ℹ️ This enum is non-exhaustive.
  - `connected` boolean, required
  - `provider_id` string, nullable, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/tryvital/apis/junction-api.md) · [All operations](https://skmtc.net/tryvital/apis/junction-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tryvital/junction-api/versions/d28f5cec7d79/schema)