PolicyHolderAPI

data object

deductible_current_accumulatednumbernullable

Amount of the current plan year's deductible the member has met so far.

deductible_current_maximumnumbernullable

The current plan year's total deductible (the amount that must be met).

deductible_previous_accumulatednumbernullable

Amount of the prior plan year's deductible the member met.

deductible_previous_maximumnumbernullable

The prior plan year's total deductible.

disabledboolean

group_namestringnullable

Name of the employer or plan group.

group_numberstringnullable

Payer's identifier for the employer or plan group.

idinteger

individual_level_idstringnullable

Carrier-side identifier unique to this individual within the policy. Unique per payer.

login_correction_messagestring

login_needs_correctionboolean

login_problem

payer object

idinteger

logo_urlstringnullable

long_namestringrequired

Includes whether this is Patient Access API, otherwise this should be the same as name

namestringrequired

policy_level_idstringnullable

Carrier-side identifier shared by everyone enrolled on the same policy (the subscriber and their dependents).

usernamestringnullable

Username for the payer-portal login this policy holder is crawled with.

PolicyHolderAPI

{
  "data": {
    "deductible_current_accumulated": 0,
    "deductible_current_maximum": 0,
    "deductible_previous_accumulated": 0,
    "deductible_previous_maximum": 0,
    "disabled": true,
    "group_name": "string",
    "group_number": "string",
    "id": 0,
    "individual_level_id": "string",
    "login_correction_message": "string",
    "login_needs_correction": true,
    "payer": {
      "id": 0,
      "logo_url": "string",
      "long_name": "string",
      "name": "string"
    },
    "policy_level_id": "string",
    "username": "string"
  }
}