Eligibility

Submit eligibility questionnaire

Submits an eligibility questionnaire for a contractor employment.

The questionnaire determines if the contractor is eligible for certain products or features. The responses are validated against the JSON schema for the questionnaire type.

Requirements:

  • Employment must be of type contractor
  • Employment must be in created status
  • Responses must conform to the questionnaire JSON schema

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. 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.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employments (employments)-Manage employments (employment:write)
Company-scoped access token (assertion)Manage employments (employments)-Manage employments (employment:write)
Customer API tokenManage employments (employments)-Manage employments (employment:write)
post/v1/contractors/eligibility-questionnaire

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/contractors/eligibility-questionnaire
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: employment:write
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: employment:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Request body

employment_slugstring uuid required

The slug/ID of the employment

responsesobject required

Responses to the questionnaire questions

type'contractor_of_record' required

Example request

{
  "employment_slug": "fd32b683-a94a-4496-a0c4-726c088af483",
  "responses": {
    "question_key1": "yes",
    "question_key2": "no"
  },
  "type": "contractor_of_record"
}

Response

Questionnaire submitted successfully

Example response

{
  "data": {
    "is_blocking": true,
    "questions": {
      "question_key1": "This is the label of the question",
      "question_key2": "This is another question label"
    },
    "responses": {
      "question_key1": "yes",
      "question_key2": "no"
    },
    "slug": "fd32b683-a94a-4496-a0c4-726c088af483",
    "submitted_at": "2021-07-15T18:18:17",
    "type": "contractor_of_record"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.