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 parameter restrictions

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

• URL-encode parameter values.

  If a parameter value includes & or =, URL-encode it so it does not break the payload.

  Do not URL-encode & and = when you use them as delimiters.

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

• Give every Indeed Apply parameter in the feed 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 in a CDATA section to remove line breaks and extra whitespace.

  Indeed Apply configuration parameters

  Parameter	Description	Example
  indeed-apply-jobUrl	Canonical URL for the full job description. Encode this URL in XML files. For applications on Indeed, the jobUrl in the apply button is the Indeed URL where the application happens.	https%3A%2F%2Fwww.yourcompany.com %2F%0Acareers%2Fyourjob123.html
  indeed-apply-jobId	Required Job ID for your internal tracking. Indeed Apply uses this value and checks it to identify duplicate applications. The description of the 409 status code mentions this job ID. Maximum 256 ASCII characters.	7775e2bc62b7f77e
  indeed-apply-jobTitle	Required Job title to display externally. Maximum 50 characters. Must match the <title> field value in the XML.	Test Engineer
  indeed-apply-jobCompanyName	Required Company name. Maximum 50 characters. Must match the <company> field value in the XML.	Your Company
  indeed-apply-jobLocation	Required Job location. Maximum 50 characters. This field requires <city>, <state>, and <country>.	New York, NY 10110
  indeed-apply-jobMeta	Additional information. This information does not appear externally, but Indeed sends it when a candidate applies 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 where 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 user names, passwords, or other PII. Do not include embedded credentials in your POST URL.	https%3A%2F%2Fwww.yourcompany.com %2Fprocess-applications
  indeed-apply-phone	String. Controls whether the job shows the phone number field. Valid value is optional, hidden, or required. Default is optional.	optional
  indeed-apply-coverletter	String. Controls whether the coverletter field is required. Valid value is optional, hidden, or required. Default is optional. Indeed sends cover letters as free-form text. If you expect an attachment, consider using a screener question to request a file upload.	required
  indeed-apply-resume	Controls 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 resume formats. Candidates can also use their Indeed resume instead of uploading one.	required
  indeed-apply-resumefieldsrequired	Japan Only Comma-separated list of resume fields that must appear in the job seeker's resume. If you populate this field, 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 Comma-separated list of resume fields that should ideally appear in the job seeker's resume. If you populate this field, it overrides the phone configuration parameter above. For more information, see the Indeed Apply Resume Field Standardization section.	languages, education
  indeed-apply-name	String. Controls whether Indeed splits the name into first and last names (indeed-apply-name=firstlastname) or shows the name in one field (indeed-apply-name=fullname). Default is one field. Indeed recommends name=firstlastname.	firstlastname
  indeed-apply-questions	Required if required by the job URL that returns a JSON-formatted string of questions for the Indeed Apply application process. Encode this URL in XML files. The URL must use HTTPS. For more information about creating questions, see Add Indeed Apply screener questions. For an example screener question JSON file, see Example Indeed Apply Screener Questions JSON file.	https%3A%2F%2Fwww.yourcompany.com %2Fjob1234%2Fquestions.json
  indeed-apply-advNum	Advertiser number to use when attributing an application conversion. This field applies only 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 information included in the application JSON data sent to the specified application URL. Indeed collects these fields and also tries to collect the job seeker's resume file.

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

Note: If the resume parameter is set to hidden, Indeed does not collect a resume file from the job seeker. However, Indeed includes data collected through indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional in the application JSON data. If the resume parameter is set to required or optional, Indeed ignores that parameter and uses indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional to collect the resume file.

If you specify indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional, Indeed ignores the phone parameter.

If you specify indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional, Indeed automatically includes namePronunciation as an optional field, even if you do not configure it. To make it required, explicitly set it to required.

You can include the following resume fields in indeed-apply-resumefieldsrequired or indeed-apply-resumefieldsoptional. If you specify the same resume field name in both, Indeed processes it as required.

Resume fields available for indeed-apply-resumefieldsrequired and indeed-apply-resumefieldsoptional, and the JSON node location where the response appears 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. This example omits them 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 full Indeed Apply application flow, including the full screener question process, use the Indeed Apply XML configuration testing tool. For more information, see Test Indeed Apply.

&nbsp;

Was this page helpful?