Check Eligibility

Beta
POST
/coverages/v1//:id/eligibility

Initiates an eligibility check. Returns the metadata of the check if successfully initiated.

Path parameters

idUUIDRequired

The unique identifier for a Coverage in the database

Request

This endpoint expects an object.
service_codeenumRequired

Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365)

date_of_servicedateRequired
npistringRequired

Response

This endpoint returns an object.
check_idstring
service_codeenum

Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365)

statusenum
Allowed values: CREATEDCOMPLETEDFAILEDPENDING

enum to represent the statuses of eligibility checks

initiated_bystring

The unique identifier for a User in the database

initiated_atdatetime
Built with