Indeed Apply configuration reference

Parameters, examples, and restrictions to configure Indeed Apply through the XML feed.

 

legal notice

• By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.

Indeed Apply configuration parameters restrictions

When you use the XML feed to configure Indeed Apply, conform to these restrictions:

• URL-encode parameters.

  & and =, when included in parameter values, must be URL-encoded to avoid breaking the payload.

  & and =, when used as delimiters, should not be URL-encoded.

  For example, &indeed-apply-jobId=Sample+ID&indeed-apply-jobCompanyName=My+Favorite&

• Ensure that any Indeed Apply parameter in the feed has a value. Otherwise, errors occur.

• Elements are not case-sensitive.

  For example, <indeed-apply-jobCompanyName> and <indeed-apply-jobcompanyname> are equivalent.

• Begin all Indeed Apply configuration parameters with <indeed-apply-.

  The Indeed Apply element wraps the configuration settings within a CDATA section to eliminate any line breaks and extra whitespace.

Indeed Apply configuration parameters

Parameter	Description	Example
indeed-apply-jobUrl	Canonical URL to the complete job description. Encode this URL in XML files. For applications on Indeed, the jobUrl is set in the apply button to the URL on Indeed where the apply occurs.	https%3A%2F%2Fwww.yourcompany.com %2F%0Acareers%2Fyourjob123.html
indeed-apply-jobId	Required ID of the job, used for your internal tracking. Used for Indeed Apply applications and to identify whether the application is a duplicate. The description of the 409 status code mentions this job ID. Contains a maximum of 256 ASCII characters.	7775e2bc62b7f77e
indeed-apply-jobTitle	Required The title of the job to display externally. (Maximum 50 characters) Must match the <title> field value in the XML.	Test Engineer
indeed-apply-jobCompanyName	Required The name of the company. (Maximum 50 characters) Must match the <company> field value in the XML.	Your Company
indeed-apply-jobLocation	Required Location of the job. (Maximum 50 characters) <city>, <state>, and <country> are required components of this field.	New York, NY 10110
indeed-apply-jobMeta	Additional information. This information does not appear externally, but is sent when using apply through the post URL.	right-rail-apply-button
indeed-apply-apiToken	Required Client ID value that you receive when you request Indeed Apply credentials. See generate an API token.	your-api-token
indeed-apply-postUrl	Required URL to which Indeed posts the application data. Encode this URL in XML files. The URL must use HTTPS and your domain. POST URLs cannot contain identifying information such as usernames, passwords, or other PII. Avoid including embedded credentials into your POST URL.	https%3A%2F%2Fwww.yourcompany.com %2Fprocess-applications
indeed-apply-phone	String. Indicates whether to show the phone number field on the job. Valid value is optional, hidden, or required. Default is optional.	optional
indeed-apply-coverletter	String. Indicates whether the coverletter field is required. Valid value is optional, hidden, or required. Default is optional. Cover letters are sent as free-form text. If an attachment is expected, consider using a screener question to request a file upload.	required
indeed-apply-resume	Indicates whether a resume is required, optional, or hidden. Valid value is optional, hidden, or required. Default is required. If you do not include this parameter, the value defaults to required. If you select optional or hidden AND do not include indeed-apply-resumefieldsoptional or indeed-apply-resumefieldsrequired, you must include screener questions. You must support .pdf, .doc, .docx, .rtf, and .txt formats for resumes. Candidates can also opt to use their Indeed resume rather than uploading one.	required
indeed-apply-resumefieldsrequired	Japan Only A comma-separated list of resume fields that must be included in the job seeker's resume. If this field is populated, it overrides the phone configuration parameter above. For more information, see the Indeed Apply Resume Field Standardization section.	phone, gender, dateOfBirth
indeed-apply-resumefieldsoptional	Japan Only A comma-separated list of resume fields that should ideally be included in the job seeker's resume. If this field is populated, it overrides the phone configuration parameter above. For more information, see the Indeed Apply Resume Field Standardization section.	languages, education
indeed-apply-name	String. Indicates whether to split the name field into first and last names (indeed-apply-name=firstlastname) or show the name in a single field (indeed-apply-name=fullname). Default is a single field. Indeed recommends that you use name=firstlastname.	firstlastname
indeed-apply-questions	Required if required by the job URL that returns a JSON-formatted string of questions to be asked during the Indeed Apply application process. Encode this URL in XML files. Must be HTTPS. For more information about creating questions, see Add Indeed Apply screener questions. For an example of a screener question JSON file, select Example Indeed Apply Screener Questions JSON file.	https%3A%2F%2Fwww.yourcompany.com %2Fjob1234%2Fquestions.json
indeed-apply-advNum	The advertiser number to use when attributing an application conversion. This field only applies to Direct Employer integrations.	1432700306306892

Indeed Apply resume field standardization

You can use indeed-apply-resumefieldsrequired and indeed-apply-resumefieldsoptional to specify and manage the resume-related information that is included as part of the application JSON data sent to the specified application URL. Indeed collects these specified fields and also attempts to collect the job seeker's resume file.

• All applications to the job include the specified indeed-apply-resumefieldsrequired fields and require the job seeker to submit a resume file.
• The specified indeed-apply-resumefieldsoptional fields are optional for the job seeker. If indeed-apply-resumefieldsrequired is not specified, attaching a resume file is optional for the job seeker.

Note: If the resume parameter is set to hidden, no resume file is collected from the job seeker, but data collected in indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional is provided as part of the application JSON data. If the resume parameter is set to required or optional, that parameter is ignored and the resume file is collected by indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional.

If the indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional field is specified, the phone parameter is ignored.

If the indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional field is specified, namePronunciation is automatically provided as an optional field without configuration. If you want to make it required, explicitly set it to required.

The following is a list of resume fields that you can include in indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional. If the same resume field name is specified in both, it is processed as required.

Resume fields available for indeed-apply-resumefieldsrequired and indeed-apply-resumefieldsoptional and the JSON node location where the response is set in the application data

Resume field standardization parameter name	JSON node location where response is set
namePronunciation	applicant.fullNamePronunciation/firstNamePronunciation/lastNamePronunciation
phone	applicant.phoneNumber
dateOfBirth	applicant.dateOfBirth
gender	applicant.gender
location	applicant.resume.json.location
positions	applicant.resume.json.positions
education	applicant.resume.json.educations
skills	applicant.resume.json.skills
languages	applicant.resume.json.languages
certifications	applicant.resume.json.certifications

XML feed with <indeed-apply-data>

This example XML feed defines one job and the <indeed-apply-data> element:.

Your XML feed must include the basic job elements, which the example omits for clarity.

<?xml version="1.0" encoding="utf-8"?>
<source>
  <!--publisher is applicable to ATS developers only-->
  <publisher/>
  <!--publisherurl is applicable to ATS developers only-->
  <publisherurl/>
  <job>
    <title/>
    <date/>
    <referencenumber/>
    <requisitionid/>
    <url/>
    <company/>
    <sourcename/>
    <city/>
    <state/>
    <country/>
    <email/>
    <postalcode/>
    <description/>
    <salary/>
    <education/>
    <jobtype/>
    <category/>
    <experience/>
    <indeed-apply-data>
      <![CDATA
      [indeed-apply-apiToken=1234ABCDE&indeed-apply-jobTitle=
      Professional+Basket+Weaver&indeed-apply-jobId=Sample+ID &indeed-apply-jobCompanyName=My+Favorite+Company
      &indeed-apply-jobLocation=Austin+TX&indeed-apply-jobUrl=
      http%3A%2F%2Fwww.indeed.com&indeed-apply-postUrl=
      https%3A%2F%2Fhookb.in%2FPxOjJqJELNH8lZLZDkpz&indeed-apply-questions
      =https%3A%2F%2Fpastebin.com%2Fraw%2F0vXq9q9b%23]]>
    </indeed-apply-data>
  </job>
</source>

Test Indeed Apply metadata

To test the entire Indeed Apply application including the full screener question process, use the Indeed Apply XML configuration testing tool. For more information about the tool, see Test Indeed Apply.

&nbsp;

Was this page helpful?