Complete Password Provider 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"
}
'

import { JunctionClient, JunctionEnvironment, PasswordProviders } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.link.completePasswordProviderMfa({
    provider: PasswordProviders.Whoop,
    mfaCode: "<mfa_code>",
});

from junction import Junction, PasswordProviders
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.link.complete_password_provider_mfa(
    PasswordProviders.WHOOP,
    mfa_code="<mfa_code>",
)

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.link.requests.CompletePasswordProviderMfaBody;
import com.junction.api.types.PasswordProviders;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.link().completePasswordProviderMfa(
    PasswordProviders.WHOOP,
    CompletePasswordProviderMfaBody.builder()
        .mfaCode("<mfa_code>")
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

response, err := c.Link.CompletePasswordProviderMfa(context.TODO(), &junction.CompletePasswordProviderMfaBody{
    Provider: junction.PasswordProvidersWhoop,
    MfaCode:  "<mfa_code>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

{
  "state": "success"
}

{
  "detail": "<unknown>"
}

POST

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"
}
'

import { JunctionClient, JunctionEnvironment, PasswordProviders } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.link.completePasswordProviderMfa({
    provider: PasswordProviders.Whoop,
    mfaCode: "<mfa_code>",
});

from junction import Junction, PasswordProviders
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.link.complete_password_provider_mfa(
    PasswordProviders.WHOOP,
    mfa_code="<mfa_code>",
)

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.link.requests.CompletePasswordProviderMfaBody;
import com.junction.api.types.PasswordProviders;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.link().completePasswordProviderMfa(
    PasswordProviders.WHOOP,
    CompletePasswordProviderMfaBody.builder()
        .mfaCode("<mfa_code>")
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

response, err := c.Link.CompletePasswordProviderMfa(context.TODO(), &junction.CompletePasswordProviderMfaBody{
    Provider: junction.PasswordProvidersWhoop,
    MfaCode:  "<mfa_code>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

{
  "state": "success"
}

{
  "detail": "<unknown>"
}

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"
}
'

import { JunctionClient, JunctionEnvironment, PasswordProviders } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.link.completePasswordProviderMfa({
    provider: PasswordProviders.Whoop,
    mfaCode: "<mfa_code>",
});

from junction import Junction, PasswordProviders
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.link.complete_password_provider_mfa(
    PasswordProviders.WHOOP,
    mfa_code="<mfa_code>",
)

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.link.requests.CompletePasswordProviderMfaBody;
import com.junction.api.types.PasswordProviders;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.link().completePasswordProviderMfa(
    PasswordProviders.WHOOP,
    CompletePasswordProviderMfaBody.builder()
        .mfaCode("<mfa_code>")
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

response, err := c.Link.CompletePasswordProviderMfa(context.TODO(), &junction.CompletePasswordProviderMfaBody{
    Provider: junction.PasswordProvidersWhoop,
    MfaCode:  "<mfa_code>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Authorizations

x-vital-api-key

string

header

required

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,

tandem_source

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

deprecated

ℹ️ This enum is non-exhaustive.

Available options:

whoop,

renpho,

peloton,

zwift,

eight_sleep,

beurer_api,

dexcom,

hammerhead,

my_fitness_pal,

kardia,

abbott_libreview,

tandem_source

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

ProviderMFARequest · object | null

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

Show child attributes

Junction Mobile SDK Integration

Device Connections

Link

Link Migration

Debugging

Device

Sleep

Sleep Cycle

Meal

Workouts

Profile

Activity

Body

Menstrual Cycle

Electrocardiogram

Vitals Timeseries

Body Timeseries

Activity Timeseries

Workout Stream Timeseries

Wellness Timeseries

Diary Timeseries

Nutrition Timeseries

Complete Password Provider MFA

Authorizations

Headers

Path Parameters

Body

Response