More information on the fields in the JSON document of the post body that represents the application.
Top-level data fields
This topic categorizes and describes the fields in the POST
body JSON document that represents the application.
Note:
The Indeed Resume fields are relevant only when an applicant uses an Indeed Resume as part of the Indeed Apply application flow. If an applicant uploads a file as a resume, the
<data>
field contains the Base64-encoded raw binary bytes of the resume file.
Field | Description | Example |
---|---|---|
id
|
Unique ID for the application as assigned by Indeed. Include this ID with the application status when sharing disposition data with Indeed. This field is also known as the |
5156eb63c9a0a8ac
9358c3a444a2818c
8a5ffdbcba5960ec
0cace3277f6b99df
|
appliedOnMillis
|
Date and time when the applicant applied, in standard UNIX time. |
1324051581711
|
job
|
Job object. Contains the HTML data attributes of your button. |
See Job object fields. |
applicant
|
Applicant object. |
|
analytics
|
Analytics object that contains:
|
|
locale
|
Locale from which applicant applied to the job. |
en_US
|
questionsAndAnswers
|
Questions and answers object. Lists the questions and answers. |
job object fields
Note:
These fields are based on the Indeed Apply configuration. These values are provided in your feeds’ Indeed Apply XML metadata and are sent back to your system in the JSON document.
<indeed-apply-data>
<![CDATA[indeed-apply-apiToken=1234ABCDE&indeed-apply-jobTitle=Professional+B
asket+Weaver&indeed-apply-jobId=Sample+ID&indeed-apply-jobCompanyName=My+Favo
rite+Company&indeed-apply-jobLocation=Austin+TX&indeed-apply-jobUrl=http%3A%2
F%2Fwww.indeed.com&indeed-apply-postUrl=https%3A%2F%2Fhookb.in%2FPxOjJqJELNH8
lZLZDkpz&indeed-apply-questions=https%3A%2F%2Fpastebin.com%2Fraw%2F0vXq9q9b%2
3]]>
</indeed-apply-data>
applicant object fields
Field | Required | Description | Example |
---|---|---|---|
fullName
|
Yes |
Name of the applicant. If the applicant is using their Indeed Resume, this value is their |
John Doe
|
email
|
Yes |
Email of the applicant. |
[email protected]
|
phoneNumber
|
No |
Phone number, if provided by the applicant. |
555-555-4321
|
coverletter
|
No |
Cover letter of the applicant. If an applicant did not provide a cover letter, this field is not in the JSON object. |
My cover letter
|
resume
|
No |
Object that reqpresents the applicant's resume. |
See the resume object fields. |
verified
|
Yes |
Indicates whether a job seeker's email address is verified. Value is:
|
true
|
resume object fields
Field | Resume upload | Indeed Resume | Description |
---|---|---|---|
file
|
Yes | Yes | Object that contains the binary resume file. |
text
|
No | Yes | A text representation of the resume. Present only if the applicant uses their Indeed Resume. |
html
|
No | Yes | Representation of the resume. Present only if the applicant uses their Indeed Resume. |
json
|
No | Yes | JSON-structured representation of the resume data. See Indeed Resume JSON object fields. |
file object fields
Indeed Resume JSON object fields
Object that contains the _total
and values
fields. The _total
field, an integer, defines the length of the array. The values
field, a JSON array, contains the _total
objects.
personalDetails object fields
Indeed resume positions object fields
Indeed resume educations object fields
Indeed resume languages object fields
Indeed resume links object fields
Indeed resume awards object fields
Indeed resume certifications object fields
Indeed resume associations object fields
Indeed resume patent object fields
Indeed resume publications object fields
Indeed resume militaryServices object fields
questionsAndAnswers object fields
Indeed’s legacy format places the screener questions and their answers in the questions
section of the JSON POST
. New integrations should disregard the legacy section of the JSON POST
and use questionsAndAnswers
object. Existing integrations leveraging the legacy format should migrate to the current format as soon as possible to avoid failures in processing screener questions.
Field | Type | Description | Example |
---|---|---|---|
url
|
string | Screener Questions url from which the questions were retrieved. |
https://apply.qa.indeed.net/ indeedapply/static/ questions/basic.json
|
retrievedOnMillis
|
string | The datetime in milliseconds at which the questions were retrieved |
1617611379562
|
questionsAndAnswers
|
array |
A list or an array of:
|
For an example, see questionsAndAnswers object example. |
questionsAndAnswers object example
[{
"question": {
"id": "automation_exp",
"question": "How many years of Automation experience do you have?",
"type": "text",
"required": true,
"format": "integer",
"min": "0",
"max": "99",
"limit": "300",
"options": [
],
"hierarchicalOptions": [
]
},
"answer": "12"
}]
Application payload examples
The following are two examples of JSON documents representing Indeed Apply applications.
Application payload with resume upload example
This example represents an application where the candidate uploaded a resume file as an attachment
Note:
For applications on Indeed, the jobUrl is set to the URL on Indeed where the apply occurs.
{
"id": "2b806761c722b0bf431e67168a74bfaf4d67e6070d6ac0160cace3277f6b99df",
"job": {
"jobId": "123456",
"jobKey": "8q2w4e4r5t6y7u8i",
"jobTitle": "Test Engineer",
"jobCompany": "Your Company",
"jobLocation": "Austin TX",
"jobUrl": "http://www.yourcompany.com/careers/yourjob123",
"jobMeta": "job-meta"
},
"applicant": {
"fullName": "Indeed Tester",
"coverletter": "Cover Letter of Indeed Tester for Your Company",
"email": "[email protected]",
"phoneNumber": "+123321-1111111",
"resume": {
"file": {
"id": "13ffsffc30b0737c5b2927c0sfqq24rr8a214ef4ca6cacded5dcaa3032e8fcd3",
"fileName": "Indeed_Tester-Upload-Resume.pdf",
"contentType": "application/pdf",
"data": "VBeead131ERi0x"
}
},
"verified": true
},
"questions": {
"url": "https://apply.qa.indeed.net/indeedapply/static/questions/basic.json",
"retrievedOnMillis": 0,
"questions": [{
"id": "automation_exp",
"question": "How many years of Automation experience do you have?",
"type": "text",
"required": true,
"format": "integer",
"min": "0",
"max": "99",
"limit": "300",
"options": [],
"hierarchicalOptions": []
},
{
"id": "japanese",
"question": "Do you speak Japanese?",
"type": "select",
"required": true,
"options": [{
"label": "Yes",
"value": "0"
},
{
"label": "No",
"value": "1"
}
],
"hierarchicalOptions": []
},
{
"id": "experience",
"question": "Describe your most favourite ice cream flavor",
"type": "textarea",
"required": false,
"options": [],
"hierarchicalOptions": []
},
{
"id": "extra",
"question": "Website Url",
"type": "text",
"required": false,
"options": [],
"hierarchicalOptions": []
},
{
"id": "multi",
"question": "Which countries would you relocate to? (you can select multiple)",
"type": "multiselect",
"required": false,
"options": [{
"label": "United States",
"value": "0"
},
{
"label": "Canada",
"value": "1"
},
{
"label": "Mexico",
"value": "2"
},
{
"label": "Belize",
"value": "3"
},
{
"label": "Other",
"value": "4"
}
],
"hierarchicalOptions": []
}
],
"answers": [{
"id": "automation_exp",
"value": "12"
},
{
"id": "japanese",
"value": "0"
},
{
"id": "experience",
"value": "Ice Cream"
},
{
"id": "extra",
"value": "www.testurl.com"
},
{
"id": "multi",
"values": [
"1",
"2",
"3"
]
}
]
},
"questionsAndAnswers": {
"url": "https://apply.qa.indeed.net/indeedapply/static/questions/basic.json",
"retrievedOnMillis": 0,
"questionsAndAnswers": [{
"question": {
"id": "automation_exp",
"question": "How many years of Automation experience do you have?",
"type": "text",
"required": true,
"format": "integer",
"min": "0",
"max": "99",
"limit": "300",
"options": [],
"hierarchicalOptions": []
},
"answer": "12"
},
{
"question": {
"id": "japanese",
"question": "Do you speak Japanese?",
"type": "select",
"required": true,
"options": [{
"label": "Yes",
"value": "0"
},
{
"label": "No",
"value": "1"
}
],
"hierarchicalOptions": []
},
"answer": {
"label": "Yes",
"value": "0"
}
},
{
"question": {
"id": "experience",
"question": "Describe your most favourite ice cream flavor",
"type": "textarea",
"required": false,
"options": [],
"hierarchicalOptions": []
},
"answer": "Ice Cream"
},
{
"question": {
"id": "extra",
"question": "Website Url",
"type": "text",
"required": false,
"options": [],
"hierarchicalOptions": []
},
"answer": "www.testurl.com"
},
{
"question": {
"id": "multi",
"question": "Which countries would you relocate to? (you can select multiple)",
"type": "multiselect",
"required": false,
"options": [{
"label": "United States",
"value": "0"
},
{
"label": "Canada",
"value": "1"
},
{
"label": "Mexico",
"value": "2"
},
{
"label": "Belize",
"value": "3"
},
{
"label": "Other",
"value": "4"
}
],
"hierarchicalOptions": []
},
"answer": [{
"label": "Canada",
"value": "1"
},
{
"label": "Mexico",
"value": "2"
},
{
"label": "Belize",
"value": "3"
}
]
}
]
},
"analytics": {
"ip": "0.0.0.0",
"advNum": "1212121212121",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.107 Safari/537.36",
"device": "desktop",
"sponsored": false
},
"appliedOnMillis": 1629153774243,
"locale": "nl"
}
Application payload with Indeed Resume example
This example represents an application where a candidate applied by using their Indeed Resume.
{
"id": "2b806761c722b0bf431e67168a74bfaf4d67e6070d6ac0160cace3277f6b99df",
"job": {
"jobId": "123456",
"jobKey": "8q2w4e4r5t6y7u8i",
"jobTitle": "Test Engineer",
"jobCompany": "Your Company",
"jobLocation": "Austin TX",
"jobUrl": "http://www.yourcompany.com/careers/yourjob123",
"jobMeta": "job-meta"
},
"applicant": {
"fullName": "Indeed Tester",
"firstName": "Indeed",
"lastName": "Tester",
"coverletter": "Cover Letter of Indeed Tester for Your Company",
"email": "[email protected]",
"phoneNumber": "+123321-1111111",
"resume": {
"file": {
"fileName": "Indeed_Tester.pdf",
"contentType": "application/pdf",
"data": "JVBERi0xL=="
},
"html": "<html><head></head><body>Resume Content</body></html>",
"json": {
"firstName": "Indeed",
"lastName": "Tester",
"email": "[email protected]",
"headline": "headline",
"summary": "summary",
"additionalInfo": "additionalinfo",
"phoneNumber": "555-555-4321",
"location": {
"country": "US",
"city": "Austin, TX",
"postalcode": "12345"
},
"personalDetails": {},
"skills": "Skill 1, Skill 2, Skill 3",
"positions": {
"_total": 2,
"values": [{
"startDateMonth": "01",
"startDateYear": "2015",
"endCurrent": true,
"title": "Product Manager",
"company": "Indeed",
"location": "Austin, TX",
"description": "This is a job I had. This is a description of what I did there. Resume used for testing purposes only."
},
{
"startDateMonth": "04",
"startDateYear": "2010",
"endDateMonth": "01",
"endDateYear": "2015",
"endCurrent": false,
"title": "Software Engineer",
"company": "Indeed",
"location": "Austin, TX",
"description": "This is a job I had. This is the description of what I did. Used for testing purposes only."
}
]
},
"educations": {
"_total": 1,
"values": [{
"degree": "Bachelor of Arts",
"field": "Graphic Design",
"school": "University of Texas",
"location": "Austin, TX",
"startDate": "2014",
"endDate": "2019",
"startDateYear": "2014",
"endDateYear": "2019",
"startDateMonth": "01",
"endDateMonth": "02",
"endCurrent": false
}]
},
"languages": {
"_total": 1,
"values": [{
"language": "French",
"proficiency": "Fluent"
}]
},
"links": {
"_total": 1,
"values": [{
"url": "http://www.indeed.com"
}]
},
"awards": {
"_total": 1,
"values": [{
"dateMonth": "04",
"dateYear": "2020",
"title": "Award Title",
"description": "award description"
}]
},
"certifications": {
"_total": 0,
"values": []
},
"associations": {
"_total": 1,
"values": [{
"startDateMonth": "01",
"startDateYear": "2014",
"endDateMonth": "06",
"endDateYear": "2018",
"endCurrent": false,
"title": "Group Title",
"description": "group description"
}]
},
"patents": {
"_total": 1,
"values": [{
"dateMonth": "04",
"dateYear": "2012",
"title": "Patent Title",
"description": "patent description",
"patentNumber": "12345",
"url": "http://www.indeed.com"
}]
},
"publications": {
"_total": 1,
"values": [{
"dateMonth": "08",
"dateYear": "2019",
"title": "Publication Title",
"description": "publication description",
"url": "http://www.indeed.com"
}]
},
"militaryServices": {
"_total": 1,
"values": [{
"startDateMonth": "02",
"startDateYear": "2003",
"endDateMonth": "05",
"endDateYear": "2009",
"endCurrent": false,
"serviceCountry": "US",
"branch": "military branch",
"rank": "rank",
"commendations": "military commendations",
"description": "military service description"
}]
}
},
"text": "resume in text format"
},
"verified": true
},
"questions": {
"url": "https://apply.qa.indeed.net/indeedapply/static/questions/basic.json",
"retrievedOnMillis": 0,
"questions": [{
"id": "automation_exp",
"question": "How many years of Automation experience do you have?",
"type": "text",
"required": true,
"format": "integer",
"min": "0",
"max": "99",
"limit": "300",
"options": [],
"hierarchicalOptions": []
},
{
"id": "japanese",
"question": "Do you speak Japanese?",
"type": "select",
"required": true,
"options": [{
"label": "Yes",
"value": "0"
},
{
"label": "No",
"value": "1"
}
],
"hierarchicalOptions": []
},
{
"id": "experience",
"question": "Describe your most favourite ice cream flavor",
"type": "textarea",
"required": false,
"options": [],
"hierarchicalOptions": []
},
{
"id": "extra",
"question": "Website Url",
"type": "text",
"required": false,
"options": [],
"hierarchicalOptions": []
},
{
"id": "multi",
"question": "Which countries would you relocate to? (you can select multiple)",
"type": "multiselect",
"required": false,
"options": [{
"label": "United States",
"value": "0"
},
{
"label": "Canada",
"value": "1"
},
{
"label": "Mexico",
"value": "2"
},
{
"label": "Belize",
"value": "3"
},
{
"label": "Other",
"value": "4"
}
],
"hierarchicalOptions": []
}
],
"answers": [{
"id": "automation_exp",
"value": "12"
},
{
"id": "japanese",
"value": "0"
},
{
"id": "experience",
"value": "Ice Cream"
},
{
"id": "extra",
"value": "www.testurl.com"
},
{
"id": "multi",
"values": [
"1",
"2",
"3"
]
}
]
},
"questionsAndAnswers": {
"url": "https://apply.qa.indeed.net/indeedapply/static/questions/basic.json",
"retrievedOnMillis": 0,
"questionsAndAnswers": [{
"question": {
"id": "automation_exp",
"question": "How many years of Automation experience do you have?",
"type": "text",
"required": true,
"format": "integer",
"min": "0",
"max": "99",
"limit": "300",
"options": [],
"hierarchicalOptions": []
},
"answer": "12"
},
{
"question": {
"id": "japanese",
"question": "Do you speak Japanese?",
"type": "select",
"required": true,
"options": [{
"label": "Yes",
"value": "0"
},
{
"label": "No",
"value": "1"
}
],
"hierarchicalOptions": []
},
"answer": {
"label": "Yes",
"value": "0"
}
},
{
"question": {
"id": "experience",
"question": "Describe your most favourite ice cream flavor",
"type": "textarea",
"required": false,
"options": [],
"hierarchicalOptions": []
},
"answer": "Ice Cream"
},
{
"question": {
"id": "extra",
"question": "Website Url",
"type": "text",
"required": false,
"options": [],
"hierarchicalOptions": []
},
"answer": "www.testurl.com"
},
{
"question": {
"id": "multi",
"question": "Which countries would you relocate to? (you can select multiple)",
"type": "multiselect",
"required": false,
"options": [{
"label": "United States",
"value": "0"
},
{
"label": "Canada",
"value": "1"
},
{
"label": "Mexico",
"value": "2"
},
{
"label": "Belize",
"value": "3"
},
{
"label": "Other",
"value": "4"
}
],
"hierarchicalOptions": []
},
"answer": [{
"label": "Canada",
"value": "1"
},
{
"label": "Mexico",
"value": "2"
},
{
"label": "Belize",
"value": "3"
}
]
}
]
},
"analytics": {
"ip": "0.0.0.0",
"advNum": "1212121212121",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.107 Safari/537.36",
"device": "desktop",
"sponsored": false
},
"appliedOnMillis": 1629153774243,
"locale": "nl"
}