Vital home page
beta
Search or ask...
GitHub
Get API Keys
Get API Keys
Search...
Navigation
User Management
Create Insurance
Documentation
API Reference
Event Catalog
Changelog
Core
Data Access
Horizon AI
Lab Testing
Org Management
User Management
POST
Create User
GET
Get User
GET
Get User by Client User ID
PATCH
Patch User
DEL
Delete User
POST
Undo User Deletion
GET
Get Teams Users
PATCH
Create User Demographics
GET
Get User Demographcis
POST
Create Insurance
GET
Get Latest Insurance
Vital Mobile SDK Integration
POST
Create Sign-In Token
Device Connections
GET
List of Providers
GET
Get User Connections
POST
Refresh User Data
DEL
Deregister Connection
Link
POST
Generate a link token
POST
Create Code
GET
Link OAuth provider
POST
Link Password provider
POST
Link Email provider
POST
Link Demo provider
POST
Complete Password Provider MFA
Link Migration
POST
Bulk Import
POST
Bulk Trigger Historical Pull
POST
Bulk Pause
POST
Bulk Export
User Management
Create Insurance
POST
/
v2
/
user
/
{user_id}
/
insurance
Try it
Authorizations
x-vital-api-key
string
header
required
Vital Team API Key
Path Parameters
user_id
string
required
Body
application/json
insured
object
required
Show child attributes
insured.
address
object
required
Show child attributes
insured.address.
city
string
required
insured.address.
country
string
required
insured.address.
first_line
string
required
insured.address.
state
string
required
insured.address.
zip
string
required
insured.address.
second_line
string | null
default:
insured.
dob
string
required
insured.
email
string
required
insured.
first_name
string
required
insured.
gender
enum<string>
required
Available options:
female
,
male
,
other
,
unknown
insured.
last_name
string
required
insured.
phone_number
string
required
member_id
string
required
payor_code
string
required
relationship
enum<string>
required
Available options:
Self
,
Spouse
,
Other
group_id
string | null
guarantor
object | null
Show child attributes
guarantor.
address
object
required
Show child attributes
guarantor.address.
city
string
required
guarantor.address.
country
string
required
guarantor.address.
first_line
string
required
guarantor.address.
state
string
required
guarantor.address.
zip
string
required
guarantor.address.
second_line
string | null
default:
guarantor.
first_name
string
required
guarantor.
last_name
string
required
guarantor.
phone_number
string
required
guarantor.
email
string | null
Response
200 - application/json
company
object
required
Show child attributes
company.
address
object
required
Show child attributes
company.address.
city
string
required
company.address.
country
string
required
company.address.
first_line
string
required
company.address.
state
string
required
company.address.
zip
string
required
company.address.
second_line
string | null
default:
company.
name
string
required
insured
object
required
Show child attributes
insured.
address
object
required
Show child attributes
insured.address.
city
string
required
insured.address.
country
string
required
insured.address.
first_line
string
required
insured.address.
state
string
required
insured.address.
zip
string
required
insured.address.
second_line
string | null
default:
insured.
dob
string
required
insured.
email
string
required
insured.
first_name
string
required
insured.
gender
enum<string>
required
Available options:
female
,
male
,
other
,
unknown
insured.
last_name
string
required
insured.
phone_number
string
required
member_id
string
required
payor_code
string
required
relationship
enum<string>
required
Available options:
Self
,
Spouse
,
Other
group_id
string | null
guarantor
object | null
Show child attributes
guarantor.
address
object
required
Show child attributes
guarantor.address.
city
string
required
guarantor.address.
country
string
required
guarantor.address.
first_line
string
required
guarantor.address.
state
string
required
guarantor.address.
zip
string
required
guarantor.address.
second_line
string | null
default:
guarantor.
first_name
string
required
guarantor.
last_name
string
required
guarantor.
phone_number
string
required
guarantor.
email
string | null
Get User Demographcis
Get Latest Insurance