Show form schema

Returns the json schema of a supported form. Possible form names are:

- address_details 
- administrative_details 
- bank_account_details 
- employment_basic_information 
- contractor_basic_information 
- contractor_contract_details 
- billing_address_details 
- contract_details 
- emergency_contact 
- emergency_contact_details 
- employment_document_details 
- personal_details 
- pricing_plan_details 
- company_basic_information 
- global_payroll_administrative_details 
- global_payroll_basic_information 
- global_payroll_contract_details 
- global_payroll_federal_taxes 
- global_payroll_personal_details 
- benefit_renewal_request 
- hris_personal_details 

Most forms require a company access token, as they are dependent on certain properties of companies and their current employments. However, the address_details and company_basic_information forms can be accessed using client_credentials authentication (without a company).

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)View forms (form:read)-
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Country code according to ISO 3-digit alphabetic codes

string
required

Name of the desired form

Query Params
string

Required for contract_amendment form

boolean

FOR TESTING PURPOSES ONLY: Include scheduled benefit groups.

boolean

Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.

≥ 1

Version of the form schema

Headers
string
required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json