API ReferencePre EncounterEligibility ChecksV1

Post

GA

Sends real-time eligibility checks to payers through Stedi.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.
payer_idstringRequired
Supported payer ID values can be found [here](https://www.stedi.com/healthcare/network).
providerobjectRequired
subscriberobjectRequired
The primary policyholder for the insurance plan or a dependent with a unique member ID. <Note>If a dependent has a unique member ID, include their information here and leave dependent undefined.</Note>
submitter_transaction_identifierstringOptional

A unique identifier for the eligibility check within the batch. Candid returns this identifier in the response for the /batch/{batch_id} polling endpoint so you can correlate benefit responses with the original eligibility check.

dependentobjectOptional
<Note>If a dependent has a unique member ID, include their information as subscriber and leave this field undefined.</Note>
encounterobjectOptional
get_existing_check_initiated_afterdatetimeOptional

If not provided, this endpoint will run a fresh eligibility check. If provided, it will return an existing successful eligibility check if one exists that was initiated after provided date with the same parameters (Date of Service, Payer ID, Provider, Subscriber, Dependent, and Encounter).

sourcestringOptional

Response

This endpoint returns an object.
responseany
batch_idstring or null
errorslist of objects or null
requestobject or null
An object representing the data for an eligibility request.
parsed_responseobject or null
request_correctionslist of objects or null