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 Authorization API

Authorization related APIs

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

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

This API exposes 2 operations across 2 paths, and defines 30 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.

2 operations 2 paths 30 schemas 1 GET1 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 Authorization 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 2

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

Authorization 2

Authorization related APIs

POST
/wf/v2/workflows/submit-authorization
Authorization Submission Request (Draft)
submitAuthorizationRequest body → 200400401403
GET
/wf/v2/workflows/submit-authorization/{task-id}
Authorization Submission Request Status
getSubmitAuthorizationRequestStatus 1 param → 200401403

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are SubmitAuthorizationRequestPayload (10 properties), TaskFailed_Authorization (8 properties), TaskSucceeded_Authorization (8 properties), TaskProgressed_Authorization (7 properties). Each schema is shown below with its type and property counts.

SubmitAuthorizationProgress
object
1 property
TaskProgressed_Authorization
object
7 properties
AuthorizationError
object
2 properties
TaskStatus_Failed
string
TaskRestarted_Authorization
object
6 properties
AuthError
object
2 properties
TaskStarted_Authorization
object
6 properties
SubmitAuthorizationFailure_submitAuthorization
object
1 property
SubmitAuthorizationFailure
object
1 property
AuthorizationTaskSuccesses
TaskSucceeded_Authorization
object
8 properties
SubmitAuthorizationSuccess
object
1 property
SubmitAuthorizationSuccessResponse
object
1 property
AuthorizationTaskFailures
SubmitAuthorizationProgress_submitAuthorization
object
1 property
TaskStatus_Queued
string
TaskName_Authorization
string
DateString
string
Date and time in ISO8601 format
SubmitAuthorizationRequestPayload
object
10 properties 9 required
inline_response_200_authorization
TaskStatus_Processing
string
TaskQueued_Authorization
object
4 properties
AuthorizationTaskProgresses
SubmitAuthorizationRequest
object
1 property 1 required
TaskRequestSuccessResponse_Authorization
object
Task Request has succeeded
4 properties
TaskStatus_Success
string
TaskFailed_Authorization
object
8 properties
AuthResponse
object
3 properties 3 required
TaskID
string
TaskRequestFailedResponse
object
Task Request has failed
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

element5-authorization-api-openapi.yml Raw ↑

Other APIs Element5 publishes across the network.

Element5 Eligibility API
Element5 Object Store API