Sign in

v71

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-032076961.5 MB
link

Complete Password Provider Mfa

This connects auth providers that are password based.

post/v2/link/provider/password/{provider}/complete_mfa

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-tokenstring nullable

Request body

mfa_codestring required

Response

Successful Response

state'success' | 'error' | 'pending_provider_mfa' required

ℹ️ This enum is non-exhaustive.

redirect_urlstring 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.

errorstring nullable

A developer-readable debug description of the Link Error. This field is populated only when state is error.

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.

connectedboolean required
provider_idstring nullable required

Example response

{
  "state": "success"
}