Get latest insurance

Retrieve user insurance latest via the Junction API. Requires authentication with your team API key.

GET /v2/user/{user_id}/insurance/latest

cURL

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' \

Response

{
  "payor_code": "UNITE",
  "member_id": "test",
  "group_id": "123",
  "relationship": "Self",
  "insured": {
    "first_name": "John",
    "last_name": "Doe", 
    "email": "[e-mail]", 
    "phone_number":"[phone]",
    "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

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' \

Response

{
  "payor_code": "UNITE",
  "member_id": "test",
  "group_id": "123",
  "relationship": "Self",
  "insured": {
    "first_name": "John",
    "last_name": "Doe", 
    "email": "[e-mail]", 
    "phone_number":"[phone]",
    "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

Query Parameters

is_primary · boolean · default: true

Response

200

application/json

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

Show child attributes

company · CompanyDetails · object · required

Show child attributes

group_id · string | null

guarantor · GuarantorDetails · object | null

Show child attributes

is_primary · boolean · default: true