Show region fields

Returns required fields JSON Schema for a given region. These are required in order to calculate the cost of employment for the region. These fields are based on employer contributions that are associated with the region or any of it's parent regions.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.
Client token (ClientToken) — a partner client_token, accepted only on marketing endpoints. See Authentication for partners.

get/v1/cost-calculator/regions/{slug}/fields

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/cost-calculator/regions/{slug}/fields
Auth: HTTP bearer and HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token) and OAuth 2 (client credentials, token URL /auth/oauth2/token)

Path parameters

slugstring required

Slug

Query parameters

include_premium_benefitsboolean

If the premium benefits should be included in the response

Response

Success

Example response

{
  "data": {
    "schema": {
      "properties": {
        "ssn": {
          "pattern": "^[0-9]{3}-[0-9]{2}-(?!0{4})[0-9]{4}$",
          "title": "Social security number",
          "type": "string",
          "x-jsf-presentation": {
            "inputType": "text",
            "mask": "___-__-____",
            "maskPlaceholder": "AAA-GG-SSSS",
            "maskSecret": 4
          }
        }
      },
      "required": [
        "ssn"
      ],
      "type": "object",
      "x-jsf-order": [
        "ssn"
      ]
    },
    "version": 7
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.