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

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

Headers

​
x-vital-link-token
string | null

Path Parameters

​
provider
enum<string>
required
Available options:
whoop,
renpho,
peloton,
zwift,
eight_sleep,
beurer_api,
dexcom,
hammerhead,
my_fitness_pal,
kardia,
abbott_libreview

Body

application/json
​
username
string
required

Username for provider

​
password
string
required

Password for provider

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

Response

200
application/json
Successful Response
​
state
enum<string>
required
Available options:
success,
error,
pending_provider_mfa
​
provider
enum<string>
required
Available options:
whoop,
renpho,
peloton,
zwift,
eight_sleep,
beurer_api,
dexcom,
hammerhead,
my_fitness_pal,
kardia,
abbott_libreview
​
connected
boolean
requireddeprecated
​
provider_id
string | null
requireddeprecated
​
redirect_url
string | null
​
error_type
string | null
​
error
string | null
​
provider_mfa
object | null
Link OAuth providerLink Email provider