API ReferenceService Eligibility

Create ServiceEligibility

Deprecated
Runs a synchronous "Hard Eligibility" check, returning when complete. Deprecated in favor of async V2 API

Authentication

X-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
serviceTypeIdstringRequired
dateOfServicedatetimeRequired
Full ISO8601 timestamp, including timezone
policyIdslist of stringsRequired
stateenumRequired
2 letter US state code
clinicalInfoobjectOptional

Response

This endpoint returns an object.
idstring
organizationIdstring
serviceTypeIdstring
dateOfServicedatetime
statusenum
Allowed values:
providerslist of objects
policyIdslist of strings
stateenum
2 letter US state code
validatedAtdatetime or null
Timestamp this was executed
patientResponsibilityobject or null

Describes the Patient Responsibility. All dollar values are in USD cents ($15 = 1500). The ‘total’ is the amount that the patient owes. The breakdown are in non-oop fields. The oop fields apply when the patient has hit (or will hit) their OOP limits.

messageslist of strings or null
clinicalInfoobject or null
conditionalPatientResponsibilitieslist of objects or null