Submit a new eligibility request

Overview

Provided a valid request, this endpoint submits a new real-time transaction for processing.
The response is JSON and includes the raw x12-271 response string so clients can extract the payer's original EDI response if needed.
Real-time response time is driven primarily by payer and clearinghouse latency. The downstream clearinghouse timeout is 2 minutes to accommodate slower payer connectivity and heavy-volume periods.
If your organization is enrolled in deduplication, that feature is evaluated before clearinghouse submission. Deduplication is customer-configurable, including the lookback window and whether prior-month requests are excluded. When a duplicate is found, the clearinghouse is skipped and the transaction sourceType is duplicate.

Coverage Discovery Integration

If you are enrolled in Coverage Discovery at the time of the request and your configured discovery conditions are met, the Coverage Discovery workflow will be started automatically. Common examples include real-time responses with status.value of ineligible or patient_unknown, or response-side HMO plan information that qualifies an HMO discovery path. In this scenario, the response link header contains one or more related Coverage Discovery task resource paths, e.g.:
</coverage-discovery/0716e3e8-87ee-11ee-b9d1-0242ac120002>; title="coverage discovery - Task 1"; rel="related", </coverage-discovery/0e565a58-87ee-11ee-b9d1-0242ac120002>; title="coverage discovery - Task 2"; rel="related"
Parse this header as RFC 8288-style link values. When more than one discovery task is created, multiple related links may be returned in the same header.
When discovery is triggered from this JSON real-time endpoint, the submitted request body is used as the canonicalEligibilityRequest later referenced by Coverage Discovery. If response-side facts are needed, the normalized real-time response body is used as canonicalEligibilityResponse.
Each related resource can be retrieved through the /coverage-discovery/{id} endpoint.
If conditions are not met, the link response header will not contain any related /coverage-discovery references.

Callback Solution With Consolidated Real-Time Eligibility and Coverage Discovery Responses

If you are enrolled in the consolidated callback capability, you may receive the Real-Time Eligibility (RTE) response together with the Coverage Discovery response.
When enabled, the abbreviated eligibility transaction will be included in the corresponding Coverage Discovery record.

⚠️ Note: This integrated response is only available via callback and only if your organization is enrolled in this capability.

Refer to the /coverage-discovery/{id} response examples for data model references.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

New real-time eligibility transaction request.

string

BHT03

string
required
length between 9 and 9

Segment: ISA, Element: ISA13, Notes: Required, Interchange Control Number - must be exactly 9 positive unsigned numeric characters.

string
length between 0 and 80

Loop: 2100A Segment: NM1, Element: NM109, Notes: we send this as MN108 as PI

string
length between 0 and 80

Loop: 2100A, Segment: NM1, Element: NM103, Notes: organizational name

provider
object
string
length between 0 and 50

Loop: 2100B, Segment: REF, Element: REF02, Notes: User Identification REF01=JD

string
length between 0 and 50

Loop: 2100B, Segment: REF, Element: REF02, Notes: Personal Identification Number (PIN) REF01=4A

informationReceiverName
object
subscriber
object
required
dependents
array of objects
length ≥ 1

Loop: 2000D, Notes: Dependent Detail

dependents
string
length between 0 and 9

Loop: 2100D Segment: INS, Element: INS17, Notes: Birth Sequence Number

string
enum

Loop: 2100D Segment: INS, Element: INS02

Allowed:
string
length between 0 and 50

Loop: 2100D Segment: REF, Element: REF02, Notes: REF01=IF Issue Number

string
length between 0 and 50

Loop: 2100D Segment: REF, Element: REF02, Notes: REF01=MRC Eligibility Category

string
length between 2 and 80

Loop: 2100C and 2100D, Segment: NM1, Element: NM109, Notes: NM108=MI

string
length between 0 and 35

Loop: 2100C and 2100D, Segment: NM1, Element: NM104

string
length between 0 and 25

Loop: 2100C and 2100D, Segment: NM1, Element: NM105

string
length between 0 and 60

Loop: 2100C and 2100D, Segment: NM1, Element: NM103

string
length between 0 and 10

Loop: 2100C and 2100D, Segment: NM1, Element: NM107

string
enum
length between 0 and 1

Loop: 2100C and 2100D, Segment: DMG, Element: DMG03

Allowed:
string

Loop: 2100C and 2100D, Segment: DMG, Element: DMG02, Notes: date of birth in YYYYMMDD

string
length between 0 and 50

Loop: 2100C and 2100D, Segment: REF, Element: REF02, Notes: REF01=SY Social Security Number

string
length between 0 and 50

Loop: 2100C and 2100D, Segment: REF, Element: REF02, Notes: REF01=6P Group Number

string
length between 0 and 50

Loop: 2100C and 2100D, Segment: REF, Element: REF02, Notes: REF01=HJ Identity Card Number

string
enum

Loop: 2100C and 2100D, Segment: PRV, Element: PRV01

string
enum

Loop: 2100C and 2100D, Segment: PRV, Element: PRV02

Allowed:
string
length between 0 and 50

Loop: 2100C and 2100D, Segment: PRV, Element: PRV03, Notes: Provider Identifier

string

Loop: 2110C and 2110D, Segment: DTP, Element: DTP03, Notes: DTP01=102, DTP02=RD8 Retired

string

Loop: 2110C and 2110D, Segment: DTP, Element: DTP03, Notes: DTP01=102, DTP02=RD8 Retired

string

Loop: 2110C and 2110D, Segment: DTP, Element: DTP03, Notes: DTP01=102, DTP02=D8 Retired

string

Loop: 2110C and 2110D, Segment: DTP, Element: DTP03, Notes: DTP01=291, DTP02=D8 Retired

string

Loop: 2110C and 2110D, Segment: DTP, Element: DTP03, Notes: DTP01=291, DTP02=RD8 Retired

string

Loop: 2110C and 2110D, Segment: DTP, Element: DTP03, Notes: DTP01=291, DTP02=RD8 Retired

healthCareCodeInformation
array of objects
length between 0 and 8

Loop: 2100C and 2100D, Segment: HI, Notes: Health Care Diagnosis

healthCareCodeInformation
address
object
additionalIdentification
object
encounter
object
Headers
string

(Optional) A unique identifier value that is attached to the response that allow reference to the original request. Differs from x-optum-trace-id as the correlation-id is stored within the datastore for future queryability.

string

(Optional) Identifies an Optum-assigned sub-tenant configuration for your organization. Include this header only when Optum has provided a value for a specific enabled customer configuration. Clients must not generate or infer this value.

x-optum-eligibility-disable-value-add
array of strings

(Optional) A comma-delimited list of strings that disable value-added features on a request-by-request basis. deduplication disables the customer-configured request deduplication feature for that request only. If you specify a value-added feature that you are not enrolled in, it will be ignored.

x-optum-eligibility-disable-value-add
Responses

link header contains related discovery task resource path(s).

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json