Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
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

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage employments (employment:write)
post/v1/contractors/eligibility-questionnaire

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