Eligibility Result

Provides status and results of an eligibility check

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

Get Eligibility Check

cURL

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

200

Initial search 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
        }
      ]
    }
  ]
}

The Eligibility request result will be sent to all active webhooks once available. As a fallback, you may call this endpoint to check result status and obtain the result.

Status

The status field in the response can have one of the following values:

Status Code	Details
complete	Indicates that the search has been completed.
processing	Signifies that the search is currently in progress, and it is recommended to retry the request later.
error	Suggests that the search dit not finished successfully, and you can find descriptions of error codes below.

Error codes

Error code	Details
insurer_problem	Insurer not available, try again later
unexpected_error	Unknown error

Webhooks

Add webhooks in the provider app to receive results into your endpoint. Webhook payload will be identical to the response of this endpoint.

When configuring a webhook you can provide a secret to sign the webhook payload and check the signature on the server side.

Signature will be sent in X-Signature header in request to webhook endpoint.

Signature is a request raw data signed with secret by HMAC SHA256 algorithm. Python example:

import hashlib
import hmac

def get_signature(secret_key: str, payload: str) -> str:
    return hmac.new(secret_key.encode(), payload.encode(), hashlib.sha256).hexdigest()

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