Eligibility Result V2

Provides status and results of an eligibility check

GET /api/auth/v2/eligibility/{request_uid}

Get Eligibility Check v2

cURL

curl --request GET \
  --url https://api.anagram.care/api/auth/v2/eligibility/{request_uid}/ \
  --header 'Authorization: <api-key>'

200

Details request result

{
  "request_uid": "f2edce8e783e4a42a50029a5ea0b0fe4",
  "status": "complete",
  "error_code": null,
  "results": [
    {
      "insurer_code": "insurer:vision:vsp",
      "id": 0,
      "plan_is_active": true,
      "status": "active",
      "plan_name": "VSP Choice Plan",
      "plan_group": "MAN GOFORG / WYMAN GORDON COMPANY",
      "plan_group_id": "30057697-0001",
      "plan_begin_date": "2023-02-01",
      "plan_end_date": null,
      "plan_refresh_date": null,
      "persons": [
        {
          "first_name": "DAN L",
          "last_name": "CAMPUS",
          "dob": "1963-07-11",
          "sex": "male",
          "member_id": null,
          "ssn_last_four": "1234",
          "type": "self",
          "address": {
            "line1": "39 CAN ROAD",
            "line2": null,
            "city": "WALLER",
            "zipcode": "77484-3862",
            "state": "TX"
          },
          "email": null,
          "phone": "8324579375",
          "id": 0,
          "full_name": "DAN L CAMPUS",
          "is_active": null,
          "plan": {
            "insurer_state": "oon",
            "begin_date": "2026-01-01",
            "refresh_date": "2026-12-31",
            "items": [
              {
                "benefit_code": "EXAM",
                "comment": "Route eye exam with refraction",
                "refresh_date": "2026-12-31",
                "copayment": [
                  {
                    "flags": [
                      "inn"
                    ],
                    "value": "10.0000"
                  },
                  {
                    "flags": [
                      "oon"
                    ],
                    "value": "15.0000"
                  }
                ],
                "allowance": [
                  {
                    "flags": [
                      "oon"
                    ],
                    "value": "45.0000"
                  }
                ],
                "quantity": [
                  {
                    "value": 1
                  }
                ],
                "quantity_accepted": [
                  {
                    "value": 0
                  }
                ],
                "quantity_reserved": [
                  {
                    "value": 0
                  }
                ]
              },
              {
                "benefit_code": "MATERIAL",
                "refresh_date": "2026-12-31",
                "items": [
                  {
                    "benefit_code": "GLASSES",
                    "flags": [
                      "exclusive-use"
                    ],
                    "copayment": [
                      {
                        "value": "25.0000"
                      }
                    ],
                    "items": [
                      {
                        "benefit_code": "FRAME",
                        "allowance": [
                          {
                            "flags": [
                              "oon"
                            ],
                            "value": "70.0000"
                          },
                          {
                            "flags": [
                              "inn"
                            ],
                            "value": "130.0000"
                          }
                        ],
                        "quantity": [
                          {
                            "value": 1
                          }
                        ],
                        "quantity_accepted": [
                          {
                            "value": 0
                          }
                        ],
                        "quantity_reserved": [
                          {
                            "value": 0
                          }
                        ],
                        "items": [
                          {
                            "benefit_code": "FRAME_TIER_1",
                            "flags": [
                              "inn"
                            ],
                            "allowance": [
                              {
                                "value": "20.0000"
                              }
                            ],
                            "quantity": [
                              {
                                "value": 1
                              }
                            ],
                            "quantity_accepted": [
                              {
                                "value": 0
                              }
                            ],
                            "quantity_reserved": [
                              {
                                "value": 0
                              }
                            ]
                          },
                          {
                            "benefit_code": "FRAME_TIER_2",
                            "flags": [
                              "inn"
                            ],
                            "end_date": "2026-06-30",
                            "allowance": [
                              {
                                "value": "40.0000"
                              }
                            ],
                            "quantity": [
                              {
                                "value": 1
                              }
                            ],
                            "quantity_accepted": [
                              {
                                "value": 0
                              }
                            ],
                            "quantity_reserved": [
                              {
                                "value": 0
                              }
                            ]
                          }
                        ]
                      },
                      {
                        "benefit_code": "LENS",
                        "quantity": [
                          {
                            "value": 2
                          }
                        ],
                        "quantity_accepted": [
                          {
                            "value": 0
                          }
                        ],
                        "quantity_reserved": [
                          {
                            "value": 0
                          }
                        ],
                        "items": [
                          {
                            "benefit_code": "LENS_ANY",
                            "flags": [
                              "inn",
                              "exclusive-use"
                            ]
                          },
                          {
                            "benefit_code": "LENS_1F",
                            "flags": [
                              "oon",
                              "exclusive-use"
                            ],
                            "allowance": [
                              {
                                "value": "50.0000"
                              }
                            ]
                          },
                          {
                            "benefit_code": "LENS_2F",
                            "flags": [
                              "oon",
                              "exclusive-use"
                            ],
                            "allowance": [
                              {
                                "value": "60.0000"
                              }
                            ]
                          },
                          {
                            "benefit_code": "LENS_3F",
                            "flags": [
                              "oon",
                              "exclusive-use"
                            ],
                            "allowance": [
                              {
                                "value": "70.0000"
                              }
                            ]
                          },
                          {
                            "benefit_code": "LENS_MATERIAL",
                            "flags": [
                              "inn",
                              "requires-parent-use",
                              "required"
                            ],
                            "items": [
                              {
                                "benefit_code": "LENS_MATERIAL_CR39",
                                "flags": [
                                  "exclusive-use"
                                ],
                                "copayment": [
                                  {
                                    "value": "0.0000"
                                  }
                                ]
                              },
                              {
                                "benefit_code": "LENS_MATERIAL_POLYCORBANATE",
                                "flags": [
                                  "exclusive-use"
                                ],
                                "copayment": [
                                  {
                                    "value": "30.0000"
                                  }
                                ]
                              },
                              {
                                "benefit_code": "LENS_MATERIAL_HI_INDEX",
                                "flags": [
                                  "exclusive-use"
                                ],
                                "copayment": [
                                  {
                                    "value": "50.0000"
                                  }
                                ]
                              }
                            ]
                          },
                          {
                            "benefit_code": "LENS_ADDON",
                            "flags": [
                              "inn",
                              "requires-parent-use"
                            ],
                            "items": [
                              {
                                "benefit_code": "LENS_ADDON_SCRETCH_RESISTANCE",
                                "copayment": [
                                  {
                                    "value": "17.0000"
                                  }
                                ]
                              },
                              {
                                "benefit_code": "LENS_ADDON_ANTI_REFLECTIVE",
                                "copayment": [
                                  {
                                    "value": "41.0000"
                                  }
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "benefit_code": "CONTACT",
                    "flags": [
                      "exclusive-use"
                    ],
                    "copayment": [
                      {
                        "flags": [
                          "oon"
                        ],
                        "value": "0.0000"
                      }
                    ],
                    "allowance": [
                      {
                        "flags": [
                          "oon"
                        ],
                        "value": "110.0000"
                      }
                    ],
                    "items": [
                      {
                        "benefit_code": "CONTACT_FIT",
                        "flags": [
                          "requires-parent-use"
                        ],
                        "copayment": [
                          {
                            "flags": [
                              "inn"
                            ],
                            "value": "60.0000"
                          }
                        ]
                      },
                      {
                        "benefit_code": "CONTACT_LENS",
                        "flags": [
                          "required"
                        ],
                        "copayment": [
                          {
                            "flags": [
                              "inn"
                            ],
                            "value": "0.0000"
                          }
                        ],
                        "allowance": [
                          {
                            "flags": [
                              "inn"
                            ],
                            "value": "130.0000"
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  ]
}

The V2 endpoint expands on V1 by returning comprehensive in-network benefit details, including coinsurance, allowances, and additional coverage information.

Flags

Benefits and benefit properties might be context-dependent, which is indicated by flags. When flags are not specified, the benefit or property is always applicable. Child benefits inherit the flag-dependent properties of parent benefits.

• inn — benefit or property is applicable only in-network
• oon — benefit or property is applicable only out-of-network
• exclusive-use — only one benefit of the same level can be used per policy year
• required — benefit is required to be used for the parent benefit to kick in
• requires-parent-use — benefit can be used if the parent benefit is already used

Authorizations

Authorization · string · header · required

Your API token prefaced with an "Api" prefix. Example value: "Api B3F4242424E3FDB4242424242A9C7642"

Path Parameters

request_uid · string · required

Response

200

application/json

request_uid · string · required

UID provided on request creation or auto generated

status · enum<string> · required

Available options: processing, complete, error

error_code · string

results · object[]

Show child attributes