Skip to main content

PolicyHolderSchema

_extranullable
accept_terms_datedate-timenullable
addressstringnullable
claim_medicalundefined[]
crawl_intervalintegernullable

Minimum days between crawls

crawlsundefined[]
createddatedate-timenullable
dataobjectnullable
dataobject_idintegernullable
date_of_birthdatenullable
deductible_current_accumulatednumbernullable
deductible_current_maximumnumbernullable
deductible_previous_accumulatednumbernullable
deductible_previous_maximumnumbernullable
dependentsundefined[]
disabledboolean
emailstringnullable
first_namestringnullable
fullnamestringnullable
group_namestringnullable
group_numberstringnullable
has_active_planbooleannullable
has_claim_medicalsboolean
idinteger
individual_level_idstringnullable

For Dependent Relationships

is_crawlableboolean
is_demoboolean
is_interop_connectedboolean
last_namestringnullable
last_successful_crawlnullable
last_successful_crawl_end
login_correction_messagestring
login_needs_correctionboolean
login_problem
migrating_datedatenullable
modifieddatedate-timenullable
next_crawl_atdate-timenullable

Earliest time at which this PH is eligible for a scheduled crawl. Written by the post-crawl hook in CrawlTask.process_end; read by tasks.dispatch_due_crawls. NULL means 'not currently scheduled' (uncrawlable, brand-new PH not yet backfilled, etc.).

parentnullable
parent_idintegernullable

Account Owner

payer_idintegerrequired
phone_numberstringnullable

Possible values: <= 20 characters

policy_holder_idinteger
policy_holder_insurance_cardsundefined[]
policy_holder_successful_emailsundefined[]
policy_level_idstringnullable

For Dependent Relationships

task_id
task_token
tenantsundefined[]
unreadinteger
usernamestringnullable
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"
}