Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Element5 Eligibility API

Eligibility related APIs

Element5 Eligibility API is one of 3 APIs that Element5 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Eligibility. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 45 schemas. It is described by OpenAPI 3.1.0, at version 2.2.0.

Requests are made against 2 base URLs: https://api-qa.e5.ai, https://api.e5.ai.

4 operations 4 paths 45 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.2.0
Base URL
https://api.e5.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Element5 Eligibility API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key provided by Element5 to authenticate and authorize the Element5 APIs

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Eligibility 4

Eligibility related APIs

POST
/wf/v2/workflows/submit-eligibility
Eligibility Submission Request
submitEligibilityRequest body → 200400401403
GET
/wf/v2/workflows/submit-eligibility/{task-id}
Eligibility Submission Request Status
getSubmitEligibilityRequestStatus 1 param → 200401403
POST
/wf/v2/workflows/process-x12-eligibility-transaction
Process X12 Eligibility Transaction (Draft)
processX12EligibilityTransactionRequest body → 200401403
GET
/wf/v2/workflows/process-x12-eligibility-transaction/{task-id}
Process X12 Eligibility Transaction Status (Draft)
getProcessX12EligibilityTransactionRequestStatus 1 param → 200401403

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are EligibilityResponse (12 properties), TaskSucceeded_EdiExchange (8 properties), TaskFailed_Eligibility (8 properties), TaskSucceeded_Eligibility (8 properties). Each schema is shown below with its type and property counts.

TaskRestarted_EdiExchange
object
6 properties
AuthorizationError
object
2 properties
TaskStatus_Failed
string
TaskRequestSuccessResponse_Eligibility
object
Task Request has succeeded
4 properties
ProcessX12EligibilityTransactionAttachment270
object
X12 270 file.
4 properties 1 required
EligibilityTaskFailures
ProcessX12EligibilityTransactionRequest
object
1 property 1 required
SubmitEligibilityFailure_submitEligibility
object
1 property
TaskSucceeded_EdiExchange
object
8 properties
AuthError
object
2 properties
TaskProgressed_Eligibility
object
7 properties
EligibilityTaskSuccesses
TaskQueued_Eligibility
object
4 properties
TaskName_Eligibility
string
TaskFailed_Eligibility
object
8 properties
TaskRequestSuccessResponse_ProcessX12EligibilityTransaction
object
Task Request has succeeded
4 properties
ProcessX12EligibilityTransactionRequestPayload
object
2 properties 2 required
inline_response_200_process_x12_eligibility_transaction
EligibilityResponse
object
12 properties 1 required
TaskName_ProcessX12EligibilityTransaction
string
SubmitEligibilitySuccessResponse
object
2 properties
TaskStatus_Queued
string
DateString
string
Date and time in ISO8601 format
EligibilityTaskProgresses
TaskStarted_Eligibility
object
6 properties
TaskQueued_EdiExchange
object
4 properties
SubmitEligibilityRequest
object
1 property 1 required
inline_response_200_eligibility
SubmitEligibilityProgress_submitEligibility
object
1 property
AvailityGateway
object
2 properties
TaskSucceeded_Eligibility
object
8 properties
TaskStatus_Processing
string
SubmitEligibilityRequestPayload
object
6 properties 5 required
SubmitEligibilityFailure
object
1 property
TaskProgressed_EdiExchange
object
7 properties
TaskStarted_EdiExchange
object
6 properties
SubmitEligibilityProgress
object
1 property
UHCGateway
object
4 properties
TaskFailed_EdiExchange
object
8 properties
ProcessX12EligibilityTransactionAttachment271
object
X12 271 file
4 properties 1 required
TaskRestarted_Eligibility
object
6 properties
TaskStatus_Success
string
WaystarGateway
object
3 properties
TaskID
string
TaskRequestFailedResponse
object
Task Request has failed
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

element5-eligibility-api-openapi.yml Raw ↑

Other APIs Element5 publishes across the network.

Element5 Authorization API
Element5 Object Store API