Skip to main content
GET
Get Policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

patient_id
integer | null
required
policy_id
integer | null
required

Response

Successful Response

hippospace
string
required
Maximum string length: 255
id
integer
required
patient_dob
string<date>
required
patient_first_name
string
required
Maximum string length: 70
patient_id
integer
required
patient_last_name
string
required
Maximum string length: 70
practice_id
integer
required
status
enum<string>
required
Available options:
active,
inactive
address
string | null
Maximum string length: 200
back_image_path
string | null

Path to the back image of the insurance card

can_check_eligibility
boolean | null
default:false

Indicates whether eligibility can be checked for this policy

carrier_id
integer | null
carrier_name
string | null
Maximum string length: 200
city
string | null
Maximum string length: 50
copay
string | null
Maximum string length: 19
Pattern: ^-?\d{1,8}(\.\d{1,10})?$|^$
county_code
string | null
Maximum string length: 10
deductible
string | null
Maximum string length: 19
Pattern: ^-?\d{1,8}(\.\d{1,10})?$|^$
end_date
string<date> | null
extension
string | null
Maximum string length: 6
front_image_path
string | null

Path to the front image of the insurance card

group_id
string | null
Maximum string length: 50
insured_person_address
string | null
Maximum string length: 200
insured_person_city
string | null
Maximum string length: 50
insured_person_dob
string<date> | null
insured_person_first_name
string | null
Maximum string length: 200
insured_person_id
string | null
Maximum string length: 50
insured_person_last_name
string | null
Maximum string length: 200
insured_person_sex_at_birth
string | null
Maximum string length: 1
insured_person_ssn
string | null
Maximum string length: 11
insured_person_state
string | null
Maximum string length: 2
insured_person_zip
string | null
Maximum string length: 10
is_legacy_insurance
boolean
default:false
medicare_secondary_code
string | null
Maximum string length: 5
member_id
string | null
Maximum string length: 50
payment_program
enum<string> | null
Available options:
medicare_part_b,
medicare_advantage,
medicaid,
commercial_hmsa,
commercial_sfhp,
commercial_other,
workers_compensation
phone
string | null
Maximum string length: 20
plan_id
integer | null
plan_name
string | null
Maximum string length: 200
rank
integer | null
relationship_to_insured
enum<string> | null
default:self
Available options:
self,
child,
spouse,
other
start_date
string<date> | null
state
string | null
Maximum string length: 2
suite
string | null
Maximum string length: 40
vendor_company_id
integer | null
vendor_external_id
string | null
Maximum string length: 100
zip
string | null
Maximum string length: 10