REremote-com
Benefit Renewals

Show benefit renewal request schema

Returns the json schema of the benefit_renewal_request form for a specific request. This endpoint requires a company access token, as forms are dependent on certain properties of companies and their current employments.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage company resources (company_admin)View benefit renewals (benefit_renewal:read)Manage benefit renewals (benefit_renewal:write)
Company-scoped access token (assertion)Manage company resources (company_admin)View benefit renewals (benefit_renewal:read)Manage benefit renewals (benefit_renewal:write)
Customer API tokenManage company resources (company_admin)View benefit renewals (benefit_renewal:read)Manage benefit renewals (benefit_renewal:write)
get/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: benefit_renewal:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: benefit_renewal:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

Path parameters

benefit_renewal_request_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Benefit Renewal Request Id

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Response

Success

dataobject

Changes

No recorded changes to this operation across all 1 revision of this API.