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, acting as the user who authorized it. 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.
• Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
• Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. 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.
• Client token (ClientToken) — a partner client_token, accepted only on the endpoints that list it. See Authentication for partners.

{
  "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
  }
}