Creating a new submission

POST

/submission/{{candidate_ref}}

Maintainer:Not configured

This endpoint creates a new submission for a candidate at HB and initiates the screening process. The URI format is: https://hb-host.tld/api/submissions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX

If the request cannot be processed due to misformatted or untranslatable data, the API should response with HTTP 400 Bad Request error

If the candidate_ref is not valid then the API should response with HTTP 404 Not Found error.

If the request cannot be processed due to data validation errors, the API should respond with HTTP 403 Forbidden and an appropriate error response.

Request

Authorization

Add parameter in header

API-Key

Example:

API-Key: ********************

Header Params

Body Params application/x-www-form-urlencoded

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/submission/{{candidate_ref}}' \
--header 'API-Version: {{api_version}}' \
--header 'API-Key: <api-key>' \
--data-urlencode 'form_type=' \
--data-urlencode 'title=' \
--data-urlencode 'first_name=' \
--data-urlencode 'last_name=' \
--data-urlencode 'home_tel=' \
--data-urlencode 'work_tel=' \
--data-urlencode 'mobile_tel=' \
--data-urlencode 'dob=' \
--data-urlencode 'home_address_line_1=' \
--data-urlencode 'home_address_line_2=' \
--data-urlencode 'home_address_line_3=' \
--data-urlencode 'home_address_town=' \
--data-urlencode 'home_address_county=' \
--data-urlencode 'home_address_postcode=' \
--data-urlencode 'home_address_country=' \
--data-urlencode 'gp_address_line_1=' \
--data-urlencode 'gp_address_line_2=' \
--data-urlencode 'gp_address_line_3=' \
--data-urlencode 'gp_address_town=' \
--data-urlencode 'gp_address_county=' \
--data-urlencode 'gp_address_postcode=' \
--data-urlencode 'gp_address_country=' \
--data-urlencode 'curr_illness_2=' \
--data-urlencode 'prev_illness=' \
--data-urlencode 'treatment=' \
--data-urlencode 'adjustments=' \
--data-urlencode 'mrsa=' \
--data-urlencode 'mrsa_date=' \
--data-urlencode 'cdiff=' \
--data-urlencode 'cdiff_date=' \
--data-urlencode 'additional_information_6=' \
--data-urlencode 'chicken_pox=' \
--data-urlencode 'chicken_pox_date=' \
--data-urlencode 'bbv=' \
--data-urlencode 'lived_outside_country=' \
--data-urlencode 'countries=' \
--data-urlencode 'bcg=' \
--data-urlencode 'bcg_date=' \
--data-urlencode 'cough=' \
--data-urlencode 'weight_loss=' \
--data-urlencode 'fever=' \
--data-urlencode 'tuberculosis_2=' \
--data-urlencode 'additional_information_3=' \
--data-urlencode 'Epp=' \
--data-urlencode 'other_information=' \
--data-urlencode 'declaration=' \
--data-urlencode 'declaration_name=' \
--data-urlencode 'declaration_date=' \
--data-urlencode 'job_role=' \
--data-urlencode 'clearance_type='

Responses

🟢201Creating a new submission

application/json

Body

Example

{
    "response": {
        "submission_ref":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
}

Modified at 2024-08-09 12:14:40

Get Form Fields

Modifying the details of an existing submission (Upload Documents)