Skip to main content

PolicyHolderSchema

_extranullable
accept_terms_datedate-timenullable

Timestamp at which the policy holder accepted the terms of service.

addressstringnullable

Policy holder's mailing address.

claim_medicalundefined[]
crawl_intervalintegernullable

Minimum days between crawls

crawlsundefined[]
createddatedate-timenullable
dataobjectnullable
dataobject_idintegernullable
date_of_birthdatenullable
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.

dependentsundefined[]
disabledboolean
emailstringnullable

Policy holder's email address.

first_namestringnullable

Policy holder's first name.

fullnamestringnullable
group_namestringnullable

Name of the employer or plan group.

group_numberstringnullable

Payer's identifier for the employer or plan group.

has_active_planbooleannullable

Whether the policy holder currently has an active insurance plan, as last observed by a crawl.

has_claim_medicalsboolean
idinteger
individual_level_idstringnullable

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

is_crawlableboolean
is_demoboolean

True if this is a demo or test policy holder rather than a real member.

is_interop_connectedboolean
last_namestringnullable

Policy holder's last name.

last_successful_crawlnullable
last_successful_crawl_end
login_correction_messagestring
login_needs_correctionboolean
login_problem
migrating_datedatenullable

Date this policy holder began migrating to a different payer (for example, a legacy payer rolling up to its Patient Access API equivalent).

modifieddatedate-timenullable
next_crawl_atdate-timenullable

Earliest time at which this policy holder is eligible for a scheduled crawl. NULL means not currently scheduled (for example, an uncrawlable PH, or a brand-new PH not yet backfilled).

parentnullable
parent_idintegernullable

The subscriber's policy holder row that this policy holder is a dependent of. NULL for a subscriber's own (top-level) policy holder.

payer_idintegerrequired
phone_numberstringnullable

Policy holder's phone number.

Possible values: <= 20 characters

policy_holder_idinteger
policy_holder_insurance_cardsundefined[]
policy_holder_successful_emailsundefined[]
policy_level_idstringnullable

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

task_id
task_token
tenantsundefined[]
unreadinteger
usernamestringnullable

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

uuiduuid
PolicyHolderSchema
{
"accept_terms_date": "2024-07-29T15:51:28.071Z",
"address": "string",
"claim_medical": [
null
],
"crawl_interval": 0,
"crawls": [
null
],
"createddate": "2024-07-29T15:51:28.071Z",
"dataobject_id": 0,
"date_of_birth": "2024-07-29",
"deductible_current_accumulated": 0,
"deductible_current_maximum": 0,
"deductible_previous_accumulated": 0,
"deductible_previous_maximum": 0,
"dependents": [
null
],
"disabled": true,
"email": "string",
"first_name": "string",
"fullname": "string",
"group_name": "string",
"group_number": "string",
"has_active_plan": true,
"has_claim_medicals": true,
"id": 0,
"individual_level_id": "string",
"is_crawlable": true,
"is_demo": true,
"is_interop_connected": true,
"last_name": "string",
"login_correction_message": "string",
"login_needs_correction": true,
"migrating_date": "2024-07-29",
"modifieddate": "2024-07-29T15:51:28.071Z",
"next_crawl_at": "2024-07-29T15:51:28.071Z",
"parent_id": 0,
"payer_id": 0,
"phone_number": "string",
"policy_holder_id": 0,
"policy_holder_insurance_cards": [
null
],
"policy_holder_successful_emails": [
null
],
"policy_level_id": "string",
"tenants": [
null
],
"unread": 0,
"username": "string",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}