Skip to main content
POST
/
v2
/
link
/
provider
/
password
/
{provider}
/
complete_mfa
curl --request POST \
     --url {{BASE_URL}}/v2/link/provider/password/{provider}/complete_mfa \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-vital-link-token: <VITAL-LINK-TOKEN>' \
     --data '
{
     "mfa_code": "012345"
}
'

{
  "state": "success"
}
curl --request POST \
     --url {{BASE_URL}}/v2/link/provider/password/{provider}/complete_mfa \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-vital-link-token: <VITAL-LINK-TOKEN>' \
     --data '
{
     "mfa_code": "012345"
}
'

Headers

​
x-vital-link-token
string | null

Path Parameters

​
provider
enum<string>
required

ℹ️ This enum is non-exhaustive.

Available options:
whoop,
renpho,
peloton,
zwift,
eight_sleep,
beurer_api,
dexcom,
hammerhead,
my_fitness_pal,
kardia,
abbott_libreview

Body

application/json
​
mfa_code
string
required

Response

Successful Response

​
state
enum<string>
required

ℹ️ This enum is non-exhaustive.

Available options:
success,
error,
pending_provider_mfa
​
provider
enum<string>
required

ℹ️ This enum is non-exhaustive.

Available options:
whoop,
renpho,
peloton,
zwift,
eight_sleep,
beurer_api,
dexcom,
hammerhead,
my_fitness_pal,
kardia,
abbott_libreview
​
connected
boolean
required
deprecated
​
provider_id
string | null
required
deprecated
​
redirect_url
string | null

The redirect URL you supplied when creating the Link Token (via POST /v2/link/token).

​
error_type
enum<string> | null

The Link Error Type. This field is populated only when state is error. ℹ️ This enum is non-exhaustive.

Available options:
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
​
error
string | null

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

​
provider_mfa
object | null

The provider MFA request. This field is populated only when state is pending_provider_mfa.