Skip to content

Get Patient Insurance Cards

Retrieve insurance card information for a specific patient, including payer details, subscriber information, and card status.

Endpoint

GET /apis/v1/insurance/cards

Query Parameters

Parameter Type Required Description
patient_id integer Yes The unique identifier of the patient

Example Request

curl '{base_url}/apis/v1/insurance/cards?patient_id=28067' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer {token}'

Response

Success Response

Status Code: 200 OK

{
  "code": 2000,
  "data": [
    {
      "insurance_card_id": 8162,
      "insurance_payer": {
        "payer_reg_id": 204,
        "name": "Amerigroup (IA, DC, MD, FL, GA, WA, TN, TX, NM)",
        "payer_type": "COMMERCIAL",
        "payer_state": null,
        "payer_id": "26375",
        "institutional_claims": null,
        "professional_claims": null,
        "era": null,
        "eligibility": "yes",
        "attachments": null,
        "workers_comp": false,
        "secondary_support": false,
        "eligibility_category": null,
        "clearing_house": "CLAIM_MD",
        "name_aliases": null,
        "credentialed": null,
        "edocument_support": true,
        "deleted": false
      },
      "insurance_number": "W585965926",
      "payer_alias_details": {
        "alias_id": "cdcf4e4d-f458-4dab-a79a-b99e784a95e3",
        "alias_name": "AMERIGROUP IOWA, INC"
      },
      "payer_id": null,
      "insurance_type": null,
      "group_name": null,
      "group_number": "",
      "plan_name": null,
      "plan_type": null,
      "pre_authorization_number": null,
      "plan_start_date": null,
      "plan_end_date": null,
      "subscriber": {
        "first_name": "CamPT",
        "middle_name": "",
        "last_name": "Rule_2",
        "date_of_birth": "2025-07-02",
        "sex": "MALE",
        "address": null,
        "subscriber_address": {
          "line1": "Uşak Merkez/Uşak",
          "line2": "",
          "landmark": "",
          "city": "Chikago",
          "state": "AK",
          "postal_code": "12548",
          "latitude": null,
          "longitude": null,
          "gps_link": null,
          "country": null,
          "plus_code": null,
          "place_id": null
        },
        "signature": "",
        "email": null,
        "phone": null,
        "relation": "SELF"
      },
      "insurance_file": {
        "file_name_front": "",
        "file_name_back": "",
        "file_url_front": "",
        "file_url_back": ""
      },
      "patient_id": 28067,
      "insurance_associate_color_code": null,
      "deleted": false,
      "insurance_card_status": "ACTIVE",
      "insurance_card_type": "PRIMARY",
      "created_at": "2025-07-10T08:28:22",
      "updated_at": "2025-07-10T08:28:22",
      "work_comp_mvc_additional_details": {
        "fax_number": null,
        "email_id": null,
        "original_claim_number": null,
        "ssn": null,
        "state": null,
        "attorney_id": null,
        "adjuster_id": null,
        "adjudicator_first_name": null,
        "adjudicator_last_name": null,
        "adjudicator_prefix": null,
        "adjudicator_email": null,
        "adjudicator_phone": null,
        "attorney_dto": null,
        "adjuster_details": null,
        "case_related_to_employment": false,
        "case_related_to_auto_accident": false,
        "case_related_to_other_accident": false,
        "date_of_accident": null,
        "qualifier": null,
        "name_of_employer": null
      },
      "insurance_used_for": "HEALTH_INSURANCE",
      "insurance_card_eligibility_details_dto": null,
      "clinic_id": 0,
      "manual_co_pay": null,
      "additional_claim_information": null,
      "payer_type": "COMMERCIAL"
    }
  ],
  "message": "Success"
}

Response Parameters

Root Level

Parameter Type Description
data array Array of insurance card records for the patient

Insurance Card Object

Parameter Type Description
insurance_card_id integer Unique identifier for the insurance card
insurance_number string Insurance member/policy number
patient_id integer Patient identifier
insurance_card_status string Status of the card (ACTIVE, INACTIVE)
insurance_card_type string Type of coverage (PRIMARY, SECONDARY)
insurance_used_for string Purpose of insurance (HEALTH_INSURANCE, etc.)
payer_type string Type of payer (COMMERCIAL, MEDICARE, MEDICAID)
group_name string Insurance group name (can be null)
group_number string Insurance group number
plan_name string Insurance plan name (can be null)
plan_type string Type of plan (can be null)
pre_authorization_number string Pre-authorization number (can be null)
plan_start_date string Plan coverage start date (can be null)
plan_end_date string Plan coverage end date (can be null)
clinic_id integer Associated clinic ID
manual_co_pay number Manual copay amount (can be null)
created_at string Record creation timestamp
updated_at string Last update timestamp
deleted boolean Whether the record is deleted

Insurance Payer Object

Parameter Type Description
payer_reg_id integer Payer registration ID
name string Full name of the insurance payer
payer_type string Type of payer (COMMERCIAL, MEDICARE, etc.)
payer_id string External payer identifier
eligibility string Eligibility verification support (yes/no)
workers_comp boolean Workers compensation support
secondary_support boolean Secondary insurance support
clearing_house string Clearinghouse used for claims
edocument_support boolean Electronic document support
deleted boolean Whether the payer is deleted

Payer Alias Details

Parameter Type Description
alias_id string Unique identifier for the alias
alias_name string Alternative name for the payer

Subscriber Object

Parameter Type Description
first_name string Subscriber's first name
middle_name string Subscriber's middle name
last_name string Subscriber's last name
date_of_birth string Subscriber's date of birth (YYYY-MM-DD)
sex string Subscriber's gender (MALE, FEMALE)
relation string Relationship to patient (SELF, SPOUSE, CHILD, etc.)
email string Subscriber's email (can be null)
phone string Subscriber's phone number (can be null)
signature string Digital signature (can be empty)

Subscriber Address Object

Parameter Type Description
line1 string Primary address line
line2 string Secondary address line
landmark string Address landmark
city string City name
state string State code
postal_code string ZIP/postal code
country string Country (can be null)
latitude number Geographic latitude (can be null)
longitude number Geographic longitude (can be null)

Insurance File Object

Parameter Type Description
file_name_front string Filename of front card image
file_name_back string Filename of back card image
file_url_front string URL to front card image
file_url_back string URL to back card image

Work Comp/MVC Additional Details

Parameter Type Description
case_related_to_employment boolean Case related to employment
case_related_to_auto_accident boolean Case related to auto accident
case_related_to_other_accident boolean Case related to other accident
date_of_accident string Date of accident (can be null)
name_of_employer string Employer name (can be null)
original_claim_number string Original claim number (can be null)
ssn string Social Security Number (can be null)

Usage Notes

Insurance Card Types

  • PRIMARY: The patient's primary insurance coverage
  • SECONDARY: Secondary or supplemental insurance coverage
  • Cards are returned in order of priority (primary first)

Payer Types

  • COMMERCIAL: Private insurance companies
  • MEDICARE: Federal health insurance program
  • MEDICAID: State and federal health insurance program
  • WORKERS_COMP: Workers' compensation insurance

Subscriber Relationships

  • SELF: Patient is the insurance subscriber
  • SPOUSE: Patient's spouse is the subscriber
  • CHILD: Patient is a child of the subscriber
  • PARENT: Patient's parent is the subscriber

File Handling

  • Insurance card images are stored with separate front and back files
  • URLs may be empty if no images have been uploaded
  • File names follow internal naming conventions

Status Management

  • ACTIVE: Card is currently valid and usable
  • INACTIVE: Card is no longer active or expired
  • deleted: Soft deletion flag for record keeping