Skip to main content

Overview

Vital's link token is a one time use token with an expiry of ten minutes.

post

/v2/link/token

Request fields and example

No parameters

Create a new link token
1
2
3
4
5
6
7
8
9
10
curl --request POST \
     --url https://api.tryvital.io/v2/link/token \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-vital-api-key: <API_KEY>' \
     --data '
{
     "user_id": "1875c190-0cd6-46c1-8670-5b56a7794b78"
}
'
Response fields and example

No parameters

Response
1
get

/v2/link/provider/oauth/{oauth_provider}

Request fields and example

No parameters

Link an OAuth Provider
1
2
3
4
5
curl --request GET \
     --url https://api.tryvital.io/v2/link/provider/oauth/{oauth_provider} \
     --header 'Accept: application/json'
     --header 'Content-Type: application/json' \
     --header 'x-vital-link-token: <VITAL-LINK-TOKEN>'
Response fields and example

No parameters

Response
1
post

/v2/link/provider/password/{provider}

Request fields and example

No parameters

Link a password provider
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
     --url https://api.tryvital.io/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"
}
'
Response fields and example

No parameters

Response
1
post

/v2/link/provider/email/{provider}

Request fields and example

No parameters

Link an email provider
1
2
3
4
5
6
7
8
9
10
curl --request POST \
     --url https://api.tryvital.io/v2/link/provider/email/{provider} \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-vital-link-token: <VITAL-LINK-TOKEN>'
     --data '
{
     "email": "test@email.com"
}
'
Response fields and example

No parameters

Response
1