Getting Started
Countries

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 
- engagement_agreement_details 
- personal_details 
- pricing_plan_details 
- company_basic_information 
- global_payroll_administrative_details 
- global_payroll_bank_account_details 
- global_payroll_basic_information 
- global_payroll_contract_details 
- global_payroll_federal_taxes 
- global_payroll_state_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).

The global_payroll_contract_details form requires the employment_id query parameter, because its fields depend on the employment. For example, overtime_eligible is shown and required only when the employment's legal entity is not on Time & Attendance 2.0. A request without employment_id returns 400.

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.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)View forms (form:read)-
get/v1/countries/{country_code}/{form}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/countries/{country_code}/{form}
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, form:read, company_admin, all:write, all:read) and OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, form:read, company_admin, all:write, all:read)

Path parameters

country_codestring required

Country code according to ISO 3-digit alphabetic codes

formstring required

Name of the desired form

Query parameters

employment_idstring

Required for contract_amendment, global_payroll_contract_details and global_payroll_state_taxes forms. Optional for contract_details, where it tailors the schema to that employment.

jurisdictionstring

Two-letter US state code. Required for global_payroll_state_taxes (e.g. NY).

only_for_testing_include_scheduled_benefit_groupsboolean

FOR TESTING PURPOSES ONLY: Include scheduled benefit groups.

skip_benefitsboolean

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

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Headers

Authorizationstring 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.

Response

Success

dataobject

Example response

{
  "data": {
    "additionalProperties": false,
    "properties": {
      "address": {
        "description": "Your street name and house number. PO Box addresses are not supported.",
        "maxLength": 255,
        "title": "Address",
        "type": "string"
      },
      "address_line_2": {
        "description": "(Optional) For example, apartment, block, or building number.",
        "maxLength": 255,
        "title": "Address line 2",
        "type": "string"
      },
      "city": {
        "description": "Enter your city",
        "maxLength": 255,
        "title": "City",
        "type": "string"
      },
      "postal_code": {
        "description": "Enter zip or postal code",
        "maxLength": 255,
        "title": "Postal code",
        "type": "string"
      }
    },
    "required": [
      "address",
      "city",
      "postal_code"
    ],
    "type": "object"
  }
}

Changes

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