Remote Benefit Offers 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 4
Across 3 paths, the API surfaces 4 operations — 3 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Country (11 properties), BenefitTier (4 properties), BenefitGroup (4 properties), OfferedBenefitGroup (3 properties). Each schema is shown below with its type and property counts.
Unified.Employment.BenefitOffer
object
The benefit offer for an employment schema
2 properties2 required
ParameterError
object
3 properties3 required
BenefitTier
object
A specific coverage level within a benefit group. For example, a "Health" benefit group might have tiers like "Basic", "Standard", and "Premium", each with dif…
4 properties4 required
OfferedBenefitGroup
object
A benefit group that has been offered to employees, including enrollment statistics aggregated across all tiers and the individual offered tiers with their own…
3 properties3 required
Unified.MinimalBenefitGroup
object
2 properties2 required
OfferedBenefitTier
object
A benefit tier that has been offered to employees, combined with enrollment statistics for that tier.
2 properties2 required
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property1 required
Slug
string
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 property1 required
UnprocessableEntityResponse
object
Country
object
A supported country on Remote
11 properties3 required
Unified.Employment.BenefitGroup
object
3 properties3 required
ActionError
object
3 properties3 required
EmployeeStats
object
Enrollment statistics for a benefit at a given level (country, group, or tier). Shows how many employees have been offered the benefit versus how many are acti…
2 properties2 required
CountrySummariesResponse
object
Response containing a company's benefit offering summaries broken down by country. Each country includes aggregate enrollment statistics and details of all off…
1 property1 required
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 property1 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
CountrySummary
object
A per-country summary of benefit offerings, including aggregate enrollment statistics and a breakdown of all offered benefit groups and their tiers for that co…
3 properties3 required
BenefitProvider
object
The insurance carrier or provider that underwrites a benefit tier. May be null if the benefit tier does not have a specific external provider assigned.
2 properties2 required
Employments.BenefitOffers.ListBenefitOffers
object
The list of benefit offers for an employment schema
Upsert benefit offers request. As its properties may vary depending on the employment, you must query the [Show benefit offers schema](tag/benefits/operation/g…
BenefitGroup
object
A category of benefits (e.g., "Health", "Dental", "Life Insurance") with a defined policy period. Each group contains one or more tiers representing different…
4 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
