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

Remote Eligibility API

The Eligibility API from Remote — 2 operation(s) for eligibility.

Remote Eligibility API is one of 101 APIs that Remote 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 2 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

2 operations 2 paths 14 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote Eligibility API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
  • ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
  • CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
  • OAuth2 — Authenticate using OAuth 2.0 protocol.
  • OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
  • OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
  • OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

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.

Eligibility 2
POST
/v1/contractors/eligibility-questionnaire
Submit eligibility questionnaire
post_v1_contractors_eligibility-questionnaire 1 param body → 201401403409422
GET
/v1/contractors/schemas/eligibility-questionnaire
Get eligibility questionnaire schema
get_v1_contractors_schemas_eligibility-questionnaire 2 params → 200401403422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are EligibilityQuestionnaire (6 properties), SubmitEligibilityQuestionnaireRequest (3 properties), ParameterError (3 properties), ActionError (3 properties). Each schema is shown below with its type and property counts.

ParameterError
object
3 properties 3 required
EligibilityQuestionnaireResponse
object
1 property 1 required
ValidationError
object
1 property 1 required
EligibilityQuestionnaire
object
6 properties 6 required
DateTime
string
UTC date time in YYYY-MM-DDTHH:mm:ss format
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property 1 required
UnprocessableEntityResponse
object
MessageResponse
object
1 property 1 required
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property 1 required
ConflictErrorResponse
object
EligibilityQuestionnaireJSONSchemaResponse
object
JSON Schema definition for eligibility questionnaire
1 property
UuidSlug
string
Identifier of the employment being terminated.
SubmitEligibilityQuestionnaireRequest
object
Request body for submitting an eligibility questionnaire
3 properties 3 required
ActionError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-eligibility-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API