OnsiteApplyConfiguration schema

This schema defines the structure for collecting job applications directly on LinkedIn for Apply Connect enabled jobs, allowing you to customize application questions when used with the Job Posting API.

Important

• Ensure that partnerQuestionIdentifier values are unique and not duplicated in job payloads. Duplicate questions will result in jobs unsuccessfully posting as onsite apply.
• For all synced jobs, ensure application questions match all questions available on customer career sites.

OnsiteApplyConfiguration fields

Field	Description	Type	Required
jobApplicationWebhookUrl	This is required for Apply Connect. The URL where you will receive job applications from LinkedIn in near-realtime for this job posting. Note: Any URL that is passed into this field must be capable of passing the Webhook Endpoint Validation Flow.	URL	Yes
questions	The object containing all necessary info to render questions to be asked for a given JobPosting. If no questions are specified, then only basic default contact information questions will be asked during the application process (first name, last name, and email).	SimpleTalentQuestions	No
onsiteApplyOptOut	LinkedIn does not enable on-site apply for this job when this value is true, and the job stays off-site.	Boolean	No

SimpleTalentQuestions fields

Field	Description	Type	Required
contactInformationQuestions	The contact information question section. If this field is null, then only mandatory contact information questions (first name, last name, and email) will be collected.	ContactInformationQuestions	No
resumeQuestions	The resume question section. If this field is null, then no resume questions will be asked.	ResumeQuestions	No
coverLetterQuestions	The cover letter question section. If this field is null, then no cover letter questions will be asked.	CoverLetterQuestions	No
workQuestions	The work questions section. If this field is null, then no work questions will be asked.	WorkQuestions	No
educationQuestions	The education question section. If this field is null, then no education questions will be asked.	EducationQuestions	No
voluntarySelfIdentificationQuestions	The voluntary self identification question section. If this field is null, then no voluntary self identification questions will be asked.	VoluntarySelfIdentificationQuestions	No
additionalQuestions	A collection of custom questions which can be added if questions don’t fit into any other question sections. Questions asked in additional Questions will be rendered in the “Additional Questions” section of the Job Application UI. If this field is null, then no Additional Questions will be asked.	AdditionalQuestions	No

ContactInformationQuestions fields

Field	Description	Type	Required
middleNameQuestionRequirement	This field captures whether middle name should be collected. Defaults to SKIP.	QuestionRequirement	No
cellphoneNumberQuestionRequirement	This field captures whether cell phone number should be collected. Defaults to OPTIONAL.	QuestionRequirement	No
locationQuestionRequirement	This field captures whether location should be collected. Defaults to SKIP.	QuestionRequirement	No
customQuestions	The custom questions to be included within the Contact Information section.	SimpleTalentQuestionDefinition[]	No

ResumeQuestions fields

Field	Description	Type	Required
resumeQuestionRequirement	This field captures whether a resume file (max 2 MB, accepted file types: “doc”, “docx”, “pdf”) needs to be provided. Defaults to OPTIONAL.	QuestionRequirement	No
customQuestions	The custom questions to be included within the Resume Question section.	SimpleTalentQuestionDefinition[]	No

CoverLetterQuestions fields

Field	Description	Type	Required
coverLetterQuestionRequirement	This field captures whether a cover letter file (max 512 KB, accepted file types: "doc", "docx", "pdf") needs to be provided. Defaults to OPTIONAL.	QuestionRequirement	No
textCoverLetterQuestionRequirement	This field captures whether to accept a multi-line text input for a cover letter. Defaults to SKIP.	QuestionRequirement	No
customQuestions	The custom questions to be included within the Cover Letter section.	SimpleTalentQuestionDefinition[]	No

WorkQuestions fields

Field	Description	Type	Required
workExperienceQuestionSet	A set of repeatable questions on work experience.	WorkExperienceQuestionSet	Yes
customQuestions	The custom questions to be included within the Work question section.	SimpleTalentQuestionDefinition[]	No

WorkExperienceQuestionSet fields

Field	Description	Type	Required
minRequired	This field requires submission of work experience. The work experience min limit can be set to 1, then at least 1 has to be provided in order to submit the subsection. If no minRequired is specified, this field will default to 0.	Integer	No
repeatLimit	The maximum number of times this question set can be asked. For example, if the value is 1 then the question set will only appear once. For this question set, the acceptable range of values is [1, 10]. If no repeatLimit is specified, this field will default to 10.	Integer	No
titleQuestionRequirement	This field captures whether the "Title" question should be asked. If not specified, this field will default to REQUIRED.	QuestionRequirement	No
employmentDatesQuestionRequirement	This field captures whether the "Employment Dates" question should be asked. If not specified, this field will default to REQUIRED.	QuestionRequirement	No
cityQuestionRequirement	This field captures whether the "City" question should be asked. If not specified, this field will default to OPTIONAL.	QuestionRequirement	No
companyQuestionRequirement	This field captures whether the "Company" question should be asked. If not specified, this field will default to OPTIONAL.	QuestionRequirement	No
descriptionQuestionRequirement	This field captures whether the "Description" question should be asked. If not specified, this field will default to OPTIONAL.	QuestionRequirement	No
customQuestions	The custom questions to be included within the Work Experience section.	SimpleTalentQuestionDefinition[]	No

EducationQuestions fields

Field	Description	Type	Required
educationExperienceQuestionSet	An education experience set of repeatable questions.	EducationExperienceQuestionSet	Yes
customQuestions	The custom questions to be included within the Education question section.	SimpleTalentQuestionDefinition[]	No

EducationExperienceQuestionSet fields

Field	Description	Type	Required
minRequired	This field requires submission of education experience. The education experience min limit can be set to 1, then at least 1 has to be provided in order to submit the subsection. If no minRequired is specified, this field will default to 0.	Integer	No
repeatLimit	The maximum number of times this question set can be asked. For example, if the value is 1 then the question set will only appear once. For this question set, the acceptable range of values is [1, 3]. If no repeatLimit is specified, this field will default to 3.	Integer	No
schoolQuestionRequirement	This field captures whether the "School" question should be asked. If not specified, this field will default to REQUIRED.	QuestionRequirement	No
datesAttendedQuestionRequirement	This field captures whether the "Dates Attended" question should be asked. If not specified, this field will default to REQUIRED.	QuestionRequirement	No
cityQuestionRequirement	This field captures whether the "City" question should be asked. If not specified, this field will default to OPTIONAL.	QuestionRequirement	No
degreeQuestionRequirement	This field captures whether the "Degree" question should be asked. If not specified, this field will default to OPTIONAL.	QuestionRequirement	No
fieldOfStudyQuestionRequirement	This field captures whether the "Field of Study" question should be asked. If not specified, this field will default to OPTIONAL.	QuestionRequirement	No
customQuestions	The additional repeatable custom questions to be included within the Education Experience question set.	SimpleTalentQuestionDefinition[]	No

VoluntarySelfIdentificationQuestions fields

Field	Description	Type	Required
disabilityQuestionRequirement	This field captures whether the Equal Employment Opportunity Commission (EEOC) Disability question should be asked. Defaults to REQUIRED.	QuestionRequirement	No
genderQuestionRequirement	This field captures whether the Equal Employment Opportunity Commission (EEOC) Gender question should be asked. Defaults to REQUIRED.	QuestionRequirement	No
raceQuestionRequirement	This field captures whether the Equal Employment Opportunity Commission (EEOC) Race question should be asked. Defaults to REQUIRED.	QuestionRequirement	No
veteranStatusQuestionRequirement	This field captures whether the Equal Employment Opportunity Commission (EEOC) Veteran Status question should be asked. Defaults to REQUIRED.	QuestionRequirement	No
customQuestions	The additional repeatable custom questions to be included within the Voluntary Self Identification question set.	SimpleTalentQuestionDefinition[]	No

AdditionalQuestions fields

Field	Description	Type	Required
customQuestionSets	A list of custom question sets to be asked in the "Additional Questions" section.	CustomQuestionSet[]	No

CustomQuestionSet fields

Field	Description	Type	Required
questions	The list of 1 or more custom questions that are a part of this custom question set. The ordering of these questions in this list will be maintained when rendering on UI.	SimpleTalentQuestionDefinition[]	No
repeatLimit	The maximum number of times this question set can be asked, for example, if the value is 1 then the question set will only appear once. For custom question sets, the valid range is [1, 10]. If no value is specified then repeatLimit will default to 1.	Integer	No

QuestionRequirement enum values

Value	Description
REQUIRED	This question is required. An answer must be provided by the applicant in order to complete the job application.
OPTIONAL	This question is optional. An answer does not need to be provided by the applicant in order to complete the job application.
SKIP	This question is not rendered on the job application. No response will be provided for this question.

SimpleTalentQuestionDefinition fields

Field	Description	Type	Required
partnerQuestionIdentifier	A unique identifier for this custom question. This is intended to be used by your systems to associate the answer(s) to this question when a job application is delivered by LinkedIn.	String	Yes
questionDetails	The details needed for a member to answer a question in any form. These question details will instruct the front-end as to how to render inputs and validation for this question.	SimpleQuestionDetails	Yes
required	This field indicates whether the question is required to complete the job application.	Boolean	Yes
questionText	The label text to describe this question. This field supports the following formats: Unordered list <ul>, List item <li>, Bold <b>, Italic <i>, Links <a>, and Paragraph <p>.	String	Yes
helpMessage	The brief additional information available to the person being asked the question.	String	No
expandedHelpMessage	The full additional information available to the person being asked the question.	String	No
prerequisiteQuestionResponse	The prerequisite question response configuration. If this field is present, this question is displayed only when the prerequisite question is answered with the prerequisite response. Note that one CustomQuestionSet can only have one prerequisite question. Each answer value of the prerequisite question can be associated to one dependency question by specifying this field in the dependency question.	PrerequisiteQuestionResponse	No

SimpleQuestionDetails fields

Field	Description	Type	Required
dateQuestionDetails	The representation of a question where a date must be provided as the answer. If this field is present, all other fields must be null.	DateQuestionDetails	No
dateRangeQuestionDetails	The representation of a question where a date range must be provided as the answer. If this field is present, all other fields must be null.	DateRangeQuestionDetails	No
documentQuestionDetails	The representation of a question where a document must be provided as the answer. If this field is present, all other fields must be null.	DocumentQuestionDetails	No
multipleChoiceQuestionDetails	The representation of a question where a multiple-choice selection must be provided as the answer. If this field is present, all other fields must be null.	MultipleChoiceQuestionDetails	No
numericQuestionDetails	The representation of a question where a number must be provided as the answer. If this field is present, all other fields must be null.	NumericQuestionDetails	No
textQuestionDetails	The representation of a question where text must be provided as the answer. If this field is present, all other fields must be null.	TextQuestionDetails	No

DateQuestionDetails fields

This is an empty record and contains no fields.

DateRangeQuestionDetails fields

Field	Description	Type	Required
startLabel	The text that will be used to describe the start date input. Defaults to "From".	String	No
endLabel	The text that will be used to describe the end date input. Defaults to "To".	String	No
hideEndDateLabel	The text that will be used to describe the input that will control whether or not the end date question is shown. For example, for employment dates this might be displayed as a checkbox with a label of "I currently work here". Checking the checkbox would unset and hide the end date question regardless of the content of the label.	String	Yes

PrerequisiteQuestionResponse fields

Field	Description	Type	Required
prerequisiteQuestion	The prerequisite question that triggers the display of this question. The prerequisite question must be a multiple choice question with RADIO_BUTTONS as form component.	PrerequisiteQuestionIdentifier	Yes
prerequisiteResponse	The required response to the prerequisite question that triggers the display of this question.	PrerequisiteAnswerValue	Yes

PrerequisiteQuestionIdentifier fields

Field	Description	Type	Required
partnerQuestionIdentifier	The identifier for custom questions. Each custom question has an identifier specified in partnerQuestionIdentifier under SimpleTalentQuestionDefinition.	String	Yes

PrerequisiteAnswerValue fields

Field	Description	Type	Required
multipleChoiceAnswerValue	An answer to a multiple choice question.	MultipleChoiceAnswerValue	Yes

DocumentQuestionDetails fields

Field	Description	Type	Required
maximumSize	The maximum allowed size of the attachment in bytes. For resume 2 MB max size limit and cover letter 512 KB max size limit. Defaults to 100 MB.	long	No
acceptableFileExtensions	The file extensions that you accept (for example, doc, docx, pdf). These should always be listed in lowercase. Leaving out this optional field indicates that the ATS has no restrictions. An empty array indicates that the ATS only accepts files with no extension.	String[]	No

MultipleChoiceQuestionDetails fields

Field	Description	Type	Required
choices	An array of possible answers to this question.	MultipleChoiceAnswerOption[]	Yes
defaultValueSymbolicName	The symbolic name for the default answer value from the array of choices.	String	No
favorableMultipleChoiceAnswer	The field that contains the favorable multiple choice answer value for this question. This should only be present for which the question has a preferred/required qualification.	FavorableMultipleChoiceAnswer	No
preferredFormComponent	This field indicates whether a set of radio buttons, a dropdown, and so on should be used to display this question.	FormComponent	No
selectMultiple	This field indicates whether the applicant is allowed to select more than one option when FormComponent is CHECKBOXES. Defaults to false.	Boolean	No

MultipleChoiceAnswerOption fields

Field	Description	Type	Required
symbolicName	The machine-parsable name to refer to this particular answer.	String	Yes
displayValue	The display value for this multiple choice answer.	String	Yes

MultipleChoiceAnswerValue fields

Field	Description	Type	Required
symbolicNames	An array of symbolic names for the answer value from the array of choices. Specify only one symbolic name when this MultipleChoiceAnswerValue is used to represent a prerequisite answer value.	String[]	Yes

FavorableMultipleChoiceAnswer fields

Field	Description	Type	Required
favorableSymbolicNames	The symbolicNames from MultipleChoiceQuestionDetails that should be considered favorable. An example could be [“BACHELOR”, “MASTERS”] to indicate that the job poster wants the candidate to have either one of the educational levels.	String[]	Yes

NumericQuestionDetails fields

Field	Description	Type	Required
decimalQuestionDetails	The details for a decimal numeric question. If this field is present, the field integerQuestionDetails must be null. If this field is null, integerQuestionDetails must be present.	DecimalQuestionDetails	Yes, if integerQuestionDetails is not provided.
integerQuestionDetails	The details for an integer numeric question. If this field is present, the field decimalQuestionDetails must be null. If this field is null, decimalQuestionDetails must be present.	integerQuestionDetails	Yes, if decimalQuestionDetails is not provided.
favorableNumericAnswer	The field that contains the favorable numeric answer value for this question. This should only be present for numeric questions for which the question is a preferred/required qualification.	String	No

DecimalQuestionDetails fields

Field	Description	Type	Required
suggestedValue	The suggested answer that is prefilled for the applicant being asked the question.	Float	No
minValue	The minimum value that is allowed for a decimal answer. Defaults to “0.0”.	Float	No
maxValue	The maximum value allowed for a decimal answer.	Float	No

IntegerQuestionDetails fields

Field	Description	Type	Required
suggestedValue	The suggested answer that is prefilled for the applicant being asked the question.	Integer	No
minValue	The minimum value that is allowed for a decimal answer. Defaults to “0”.	Integer	No
maxValue	The maximum value allowed for an integer answer.	Integer	No

FavorableNumericAnswer fields

Field	Description	Type	Required
favorableFloor	The minimum inclusive value that will be considered favorable. For example, this field would be set to 5.0 if you want to capture ‘Minimum 5 years of experience’. Null means negative infinity.	Float	No
favorableCeiling	The maximum inclusive value that will be considered favorable. Null means infinity.	Float	No

TextQuestionDetails fields

Field	Description	Type	Required
suggestedValue	The suggested answer that is prefilled for the applicant being asked the question.	String	No
minLength	The minimum text length for the answer. Defaults to 0.	Integer	No
maxLength	The maximum text length for the answer. The value should be greater than 0.	Integer	No
preferredFormComponent	This field indicates whether a one-line or multi-line text input should be used. The value should be TEXT or MULTILINE_TEXT.	FormComponent	No

FormComponent enum values

Value	Description
CHECKBOXES	A series of checkboxes - one for each option.
DROPDOWN	A vertical list of options.
MULTILINE_TEXT	A free-form text area that accepts multiple lines of text.
RADIO_BUTTONS	A list of options with a toggle next to each one. Selecting one option will deselect all others.
TEXT	A free-form text area that accepts only one line of text.
BUTTONS	A series of buttons - one for each option.