---
title: "Submit Reference Online Form"
method: POST
path: "/reference-online-form/{public_reference_id}/submit"
tags: ["Reference Online Form Content"]
---

# Submit Reference Online Form

`POST /reference-online-form/{public_reference_id}/submit`

## Headers

- `Accept` 'application/json', required
- `If-Match` string

## Request body

- object
  - `online_form_question_and_answers` object[], required
    - `question_reference` string, required
    - `order` number, required
    - `answers` object[], required
      - `answer_reference` string, required
      - `answer_value` string, required
  - `reference_form_type_name` string, required
  - `esign_image` string, required
  - `reference` object, required
    - `agency_group_id` string, required
    - `name` string, required
    - `position` string, required
    - `type` 'professional' | 'character', required
    - `work_contact_number` string
    - `mobile_contact_number` string
    - `email_address` string, email, required
    - `fax_number` string
    - `start_at` string, date, required
    - `end_at` string, date
    - `relationship` string
    - `employer` object
      - `name` string, required
      - `contact_number` string, required
      - `address` object, required
        - `address_line1` string
        - `address_line2` string
        - `city` string
        - `province` string
        - `country_code` string, required
        - `post_code` string
  - `candidate` object, required
    - `first_name` string, required
    - `last_name` string, required
    - `current_candidate_type` string, required
    - `current_candidate_type_display_name` string, required
    - `professional_reference_numbers` string[], required
  - `reference_settings` object, required
    - `agency_group_id` string, required
    - `agency_group_configurables` object, required
      - `agency_group_name` string, required
      - `logo` string, required
      - `address` object, required
        - `address_line1` string
        - `address_line2` string
        - `city` string
        - `province` string
        - `country_code` string, required
        - `post_code` string
      - `phone_number` string, required
      - `email_address` string, email, required
      - `website` string, required
    - `reference_type_configurables` object, required
      - `type` 'professional' | 'character', required
      - `introduction_text` string
      - `rehabilitation_of_offenders_text` string
      - `esign_disclaimer_text` string, required
      - `show_introduction_text` boolean, required
      - `show_rehabilitation_of_offenders` boolean, required
      - `show_professional_reference_numbers` boolean, required
      - `show_esign_disclaimer` boolean, required

## Response `202`

Reference Online Form will be submitted

- string

## Other responses

- `400` — Validation error. Usually caused by a missing or invalid parameter
- `404` — Resource not found
- `412` — Request precondition failed
- `default` — Server error occurred

---

[API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) · [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/staffshift/staffshift-api-gateway/revisions/6e2cb83db3a9/schema)