Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Cost Calculator

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.

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

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