v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB

INSURANCE POLICIES

Put Policy

put/patients/{patient_id}/policies/{policy_id}

Path parameters

patient_idinteger required

policy_idinteger required

Request body

addressstring nullable

Carrier street address

carrier_idinteger nullable

Insurance carrier identifier

carrier_namestring nullable

Name of the insurance carrier

citystring nullable

Carrier city

copaystring nullable

Copay amount

county_codestring nullable

Carrier county code

deductiblestring nullable

Deductible amount

end_datestring date nullable

Policy end date

extensionstring nullable

Carrier phone extension

group_idstring nullable

Group identifier

idinteger nullable

Policy ID. If provided, updates the existing policy. If omitted, creates a new policy with a generated ID.

insured_person_addressstring nullable

Insured person's street address

insured_person_citystring nullable

Insured person's city

insured_person_dobstring date nullable

Insured person's date of birth

insured_person_first_namestring nullable

Insured person's first name

insured_person_idstring nullable

Insured person's identifier

insured_person_last_namestring nullable

Insured person's last name

insured_person_sex_at_birthstring nullable

Insured person's sex at birth

insured_person_ssnstring nullable

Insured person's SSN

insured_person_statestring nullable

Insured person's state code

insured_person_zipstring nullable

Insured person's ZIP code

medicare_secondary_codestring nullable

Medicare secondary code

member_idstring nullable

Member identifier

patient_dobstring date required

Patient's date of birth

patient_first_namestring required

Patient's first name

patient_last_namestring required

Patient's last name

phonestring nullable

Carrier phone number

plan_idinteger nullable

Insurance plan identifier

plan_namestring nullable

Name of the insurance plan

rankinteger nullable

Policy rank (1=primary, 2=secondary, 3=tertiary)

relationship_to_insured'self' | 'child' | 'spouse' | 'other'

start_datestring date nullable

Policy start date

statestring nullable

Carrier state code

status'active' | 'inactive'

suitestring nullable

Carrier suite/unit number

vendor_company_idinteger nullable

For internal use only

vendor_external_idstring nullable

For internal use only

zipstring nullable

Carrier ZIP code

Response

Successful Response

addressstring nullable

Carrier street address

carrier_idinteger nullable

Insurance carrier identifier

carrier_namestring nullable

Name of the insurance carrier

citystring nullable

Carrier city

copaystring nullable

Copay amount

county_codestring nullable

Carrier county code

deductiblestring nullable

Deductible amount

end_datestring date nullable

Policy end date

extensionstring nullable

Carrier phone extension

group_idstring nullable

Group identifier

idinteger nullable

Policy ID. If provided, updates the existing policy. If omitted, creates a new policy with a generated ID.

insured_person_addressstring nullable

Insured person's street address

insured_person_citystring nullable

Insured person's city

insured_person_dobstring date nullable

Insured person's date of birth

insured_person_first_namestring nullable

Insured person's first name

insured_person_idstring nullable

Insured person's identifier

insured_person_last_namestring nullable

Insured person's last name

insured_person_sex_at_birthstring nullable

Insured person's sex at birth

insured_person_ssnstring nullable

Insured person's SSN

insured_person_statestring nullable

Insured person's state code

insured_person_zipstring nullable

Insured person's ZIP code

medicare_secondary_codestring nullable

Medicare secondary code

member_idstring nullable

Member identifier

patient_dobstring date required

Patient's date of birth

patient_first_namestring required

Patient's first name

patient_last_namestring required

Patient's last name

phonestring nullable

Carrier phone number

plan_idinteger nullable

Insurance plan identifier

plan_namestring nullable

Name of the insurance plan

rankinteger nullable

Policy rank (1=primary, 2=secondary, 3=tertiary)

relationship_to_insured'self' | 'child' | 'spouse' | 'other'

start_datestring date nullable

Policy start date

statestring nullable

Carrier state code

status'active' | 'inactive'

suitestring nullable

Carrier suite/unit number

vendor_company_idinteger nullable

For internal use only

vendor_external_idstring nullable

For internal use only

zipstring nullable

Carrier ZIP code