Skip to main content
GET
/
v2
/
user
/
{user_id}
/
insurance
/
latest
curl --request GET \
     --url {{BASE_URL}}/v2/user/{user_id}/insurance/latest \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Content-Type: application/json' \

{
  "payor_code": "UNITE",
  "member_id": "test",
  "group_id": "123",
  "relationship": "Self",
  "insured": {
    "first_name": "John",
    "last_name": "Doe", 
    "email": "[email protected]", 
    "phone_number":"+1123123123",
    "gender": "Male", 
    "dob": "1999-01-01", 
    "address": {
      "first_line": "Some Street", 
      "second_line": null,
      "zip_code": "85004",
      "state": "AZ",
      "city": "Phoenix",
    }
  }
}

This feature is in closed beta.Interested in this feature? Get in touch with your Customer Success Manager.
curl --request GET \
     --url {{BASE_URL}}/v2/user/{user_id}/insurance/latest \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Content-Type: application/json' \

{
  "payor_code": "UNITE",
  "member_id": "test",
  "group_id": "123",
  "relationship": "Self",
  "insured": {
    "first_name": "John",
    "last_name": "Doe", 
    "email": "[email protected]", 
    "phone_number":"+1123123123",
    "gender": "Male", 
    "dob": "1999-01-01", 
    "address": {
      "first_line": "Some Street", 
      "second_line": null,
      "zip_code": "85004",
      "state": "AZ",
      "city": "Phoenix",
    }
  }
}

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
user_id
string
required

Response

Successful Response

​
member_id
string
required
​
payor_code
string
required
​
relationship
enum<string>
required

ℹ️ This enum is non-exhaustive.

Available options:
Self,
Spouse,
Other
​
insured
PersonDetails · object
required
​
company
CompanyDetails · object
required
​
group_id
string | null
​
guarantor
GuarantorDetails · object