curl --request GET \
--url https://{region}.affinda.com/v2/resumes/{identifier} \
--header 'Authorization: Bearer <token>'{
"data": {
"name": {
"raw": "Tim A. Smith",
"first": "Tim",
"last": "Smith",
"middle": "A.",
"title": "Dr"
},
"phoneNumbers": [
"(704) 996-9966",
"+61412632636"
],
"phoneNumberDetails": [
{
"rawText": "+61412632636",
"formattedNumber": "+61 412 632 636",
"countryCode": "AU",
"internationalCountryCode": 61,
"nationalNumber": "0412 632 636"
}
],
"websites": [
"www.timsmith.com"
],
"emails": [
"[email protected]"
],
"dateOfBirth": "1992-01-01",
"location": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
},
"objective": "",
"languages": [
"English",
"French",
"Arabic"
],
"languageCodes": [
"en",
"fr",
"ar"
],
"summary": "",
"totalYearsExperience": 13,
"headShot": "aSDinaTvuI8gbWludGxpZnk=",
"education": [
{
"id": 2,
"organization": "Virginia Polytechnic Institute and State University (Virginia Tech)",
"accreditation": {
"education": "Bachelor of Science",
"inputStr": "Bachelor of Science, Mechanical Engineering, expected",
"matchStr": "Bachelor of Science",
"educationLevel": "bachelors"
},
"grade": {
"raw": "GPA : 3.35",
"metric": "GPA",
"value": "3.35"
},
"location": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
},
"dates": {
"completionDate": "2021-05-01",
"isCurrent": true,
"startDate": "2019-05-01",
"rawText": "May-Aug '18"
}
}
],
"profession": "Software Developer",
"linkedin": "https://www.linkedin.com/in/user-name",
"workExperience": [
{
"id": 2,
"jobTitle": "Sales and retail assistants",
"socCode": "7111",
"socName": "Sales and retail assistants",
"organization": "General Motors",
"industry": "Automotive",
"location": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
},
"jobDescription": "Interned with supercar Development from May 2017 to August 2017.",
"dates": {
"startDate": "2018-05-01",
"endDate": "2018-08-01",
"monthsInPosition": 1,
"isCurrent": true,
"rawText": "May-Aug '18"
},
"occupation": {
"jobTitle": "Sr. Software Developer",
"jobTitleNormalized": "Software Developer",
"emsiId": "ETE2AD3A1C11B4EC9B",
"managementLevel": "Low",
"classification": {
"title": "Book-keepers, payroll managers and wages clerks",
"minorGroup": "Administrative Occupations: Finance",
"subMajorGroup": "ADMINISTRATIVE OCCUPATIONS",
"majorGroup": "ADMINISTRATIVE AND SECRETARIAL OCCUPATIONS",
"socCode": 4122,
"minorGroupCode": 4122,
"subMajorGroupCode": 4122,
"majorGroupCode": 4122
}
}
}
],
"skills": [
{
"id": 2,
"emsiId": "KS1218W78FGVPVP2KXPX",
"name": "Applied Mechanics",
"lastUsed": "2012-01-01",
"numberOfMonths": 12,
"type": "hard_skill",
"count": 10,
"weighting": 0.057699221573302296,
"sources": [
{
"section": "WorkExperience",
"position": 0,
"workExperienceId": 1234
}
]
}
],
"certifications": [
"Certificate in AWS"
],
"publications": [
"Tim Smith et al., Investigations of nanoparticles in the pathology of the human eye, Cell 2014"
],
"referees": [
{
"name": "Stephen Smith",
"text": "Stephen Smith, Team Member/Mentor, Company Power Generation: [email protected]",
"email": "[email protected]",
"number": "+61490667215",
"position": "Principal"
}
],
"sections": [
{
"sectionType": "PersonalDetails",
"bbox": [
0,
36.392,
612,
111.056
],
"pageIndex": 0,
"text": "<All text from the {sectionType} section>"
}
],
"isResumeProbability": 98,
"rawText": "Christopher Nolan 3210 fake street '... <rest of resume text>'",
"redactedText": "**** Objective: To obtain a job '... <rest of resume text>'"
},
"meta": {
"identifier": "<string>",
"customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
"fileName": "Document.pdf",
"ready": true,
"readyDt": "2020-12-10T01:43:32.276724Z",
"failed": false,
"expiryTime": "2023-11-07T05:31:56Z",
"language": "en",
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"parentDocument": {
"identifier": "<string>"
},
"childDocuments": [
{
"identifier": "<string>"
}
],
"pages": [
{
"id": 2,
"pageIndex": 0,
"image": "https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"height": 700,
"width": 500,
"rotation": 90,
"imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
}
],
"isVerified": false,
"reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
"ocrConfidence": 0.97,
"createdDt": "2023-11-07T05:31:56Z",
"documentType": "resume",
"regionBias": {
"country": "<string>",
"countries": [
"<string>"
],
"squareCoordinates": [
123
],
"strict": true
},
"isOcrd": true
},
"error": {
"errorCode": "document_conversion_failed",
"errorDetail": "Unable to convert word document"
}
}Returns all the parse results for that resume if processing is completed.
The identifier is the unique ID returned after POST-ing the resume via the /resumes endpoint.
curl --request GET \
--url https://{region}.affinda.com/v2/resumes/{identifier} \
--header 'Authorization: Bearer <token>'{
"data": {
"name": {
"raw": "Tim A. Smith",
"first": "Tim",
"last": "Smith",
"middle": "A.",
"title": "Dr"
},
"phoneNumbers": [
"(704) 996-9966",
"+61412632636"
],
"phoneNumberDetails": [
{
"rawText": "+61412632636",
"formattedNumber": "+61 412 632 636",
"countryCode": "AU",
"internationalCountryCode": 61,
"nationalNumber": "0412 632 636"
}
],
"websites": [
"www.timsmith.com"
],
"emails": [
"[email protected]"
],
"dateOfBirth": "1992-01-01",
"location": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
},
"objective": "",
"languages": [
"English",
"French",
"Arabic"
],
"languageCodes": [
"en",
"fr",
"ar"
],
"summary": "",
"totalYearsExperience": 13,
"headShot": "aSDinaTvuI8gbWludGxpZnk=",
"education": [
{
"id": 2,
"organization": "Virginia Polytechnic Institute and State University (Virginia Tech)",
"accreditation": {
"education": "Bachelor of Science",
"inputStr": "Bachelor of Science, Mechanical Engineering, expected",
"matchStr": "Bachelor of Science",
"educationLevel": "bachelors"
},
"grade": {
"raw": "GPA : 3.35",
"metric": "GPA",
"value": "3.35"
},
"location": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
},
"dates": {
"completionDate": "2021-05-01",
"isCurrent": true,
"startDate": "2019-05-01",
"rawText": "May-Aug '18"
}
}
],
"profession": "Software Developer",
"linkedin": "https://www.linkedin.com/in/user-name",
"workExperience": [
{
"id": 2,
"jobTitle": "Sales and retail assistants",
"socCode": "7111",
"socName": "Sales and retail assistants",
"organization": "General Motors",
"industry": "Automotive",
"location": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
},
"jobDescription": "Interned with supercar Development from May 2017 to August 2017.",
"dates": {
"startDate": "2018-05-01",
"endDate": "2018-08-01",
"monthsInPosition": 1,
"isCurrent": true,
"rawText": "May-Aug '18"
},
"occupation": {
"jobTitle": "Sr. Software Developer",
"jobTitleNormalized": "Software Developer",
"emsiId": "ETE2AD3A1C11B4EC9B",
"managementLevel": "Low",
"classification": {
"title": "Book-keepers, payroll managers and wages clerks",
"minorGroup": "Administrative Occupations: Finance",
"subMajorGroup": "ADMINISTRATIVE OCCUPATIONS",
"majorGroup": "ADMINISTRATIVE AND SECRETARIAL OCCUPATIONS",
"socCode": 4122,
"minorGroupCode": 4122,
"subMajorGroupCode": 4122,
"majorGroupCode": 4122
}
}
}
],
"skills": [
{
"id": 2,
"emsiId": "KS1218W78FGVPVP2KXPX",
"name": "Applied Mechanics",
"lastUsed": "2012-01-01",
"numberOfMonths": 12,
"type": "hard_skill",
"count": 10,
"weighting": 0.057699221573302296,
"sources": [
{
"section": "WorkExperience",
"position": 0,
"workExperienceId": 1234
}
]
}
],
"certifications": [
"Certificate in AWS"
],
"publications": [
"Tim Smith et al., Investigations of nanoparticles in the pathology of the human eye, Cell 2014"
],
"referees": [
{
"name": "Stephen Smith",
"text": "Stephen Smith, Team Member/Mentor, Company Power Generation: [email protected]",
"email": "[email protected]",
"number": "+61490667215",
"position": "Principal"
}
],
"sections": [
{
"sectionType": "PersonalDetails",
"bbox": [
0,
36.392,
612,
111.056
],
"pageIndex": 0,
"text": "<All text from the {sectionType} section>"
}
],
"isResumeProbability": 98,
"rawText": "Christopher Nolan 3210 fake street '... <rest of resume text>'",
"redactedText": "**** Objective: To obtain a job '... <rest of resume text>'"
},
"meta": {
"identifier": "<string>",
"customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
"fileName": "Document.pdf",
"ready": true,
"readyDt": "2020-12-10T01:43:32.276724Z",
"failed": false,
"expiryTime": "2023-11-07T05:31:56Z",
"language": "en",
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"parentDocument": {
"identifier": "<string>"
},
"childDocuments": [
{
"identifier": "<string>"
}
],
"pages": [
{
"id": 2,
"pageIndex": 0,
"image": "https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"height": 700,
"width": 500,
"rotation": 90,
"imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
}
],
"isVerified": false,
"reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
"ocrConfidence": 0.97,
"createdDt": "2023-11-07T05:31:56Z",
"documentType": "resume",
"regionBias": {
"country": "<string>",
"countries": [
"<string>"
],
"squareCoordinates": [
123
],
"strict": true
},
"isOcrd": true
},
"error": {
"errorCode": "document_conversion_failed",
"errorDetail": "Unable to convert word document"
}
}Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}.
You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.
Document identifier A random string that uniquely identify the resource.
Set this to "hr-xml" to get the response in HR-XML format. Currently the only supported value for this parameter is "hr-xml".
hr-xml Successfully retrieved resume
A JSON-encoded string of the ResumeData object.
Show child attributes
["(704) 996-9966", "+61412632636"]Show child attributes
"+61412632636"
"+61 412 632 636"
"AU"
x >= 161
"0412 632 636"
["www.timsmith.com"]"1992-01-01"
Show child attributes
"Blacksburg, VA"
"Blacksburg, VA, USA"
"3124"
"Virginia"
"TX"
"United States"
Two letter country code (ISO 3166-1 alpha-2)
"US"
"1"
"Smith St"
"12"
"Blacksburg"
"67.0124"
"67.0124"
"P.O. Box 123"
Ainu, Akan, Akkadian, Amharic, Anam, Arabic, Aramaic, Arem, Armenian, Awadhi, Aymara, Azari, Bagheli, Bagri, Bahasa, Bahasa Indonesian, Bambara, Bangala, Bardi, Bassa, Batak, Belarusian, Bemba, Benga, Bengali, Berber, Bhojpuri, Bislama, Brahui, Bulgarian, Bunu, Cambodian, Carew, Carib, Catalan, Cebuano, Chakma, Chamorro, Chango, Chewa, Croatian, Czech, Dagbani, Danish, Dari, Dayi, Dhatki, Dhivehi, Dinka, Dogri, Duala, Dutch, English, Esperanto, Estonian, Ewondo, Faroese, Filipino, Finnish, Formula, French, Frisian, Friulian, Fula, Gaelic, Galo, Garhwali, Garifuna, German, Gikuyu, Gujarati, Gujerati, Gwere, Hawaiian, Haya, Hebrew, Hindi, Hmu, Hokkien, Hopi, Hungarian, Hup, Ibanag, Igbo, Ilokano, Indonesian, Intermediate, Irish, Italian, Japanese, Jiba, Kachin, Kalenjin, Kamayo, Kannada, Kaonde, Kayan, Khandeshi, Khmer, Kikuyu, Kodava, Koma, Kongo, Konkani, Korean, Korwa, Kreyol, Krio, Kumaoni, Kurdish, Kurukh, Kwa, Ladino, Lango, Latvian, Lawa, Lingala, Lithuanian, Lule, Luxembourgish, Magahi, Maithili, Malay, Malayalam, Malaysian, Malvi, Maninka, Manipuri, Manx, Marathi, Mayan, Medumba, Memoni, Mewari, Mizo, Montenegrin, Mwan, Mwanga, Ndebele, Nepali, Nimadi, Oriya, Oromo, Ovambo, Pamona, Pangasinan, Pashto, Phoenician, Polish, Portuguese, Pulaar, Pular, Punjabi, Quecha, Rajasthani, Romanian, Russian, Sakha, Sango, Santhali, Saraiki, Seim, Shading, Shama, Shan, Shona, Silesian, Sindhi, Slovak, Slovene, Soga, Sogdian, Sotho, Spanish, Sudanese, Sumerian, Surajpuri, Surigaonon, Swati, Swazi, Swedish, Tagalog, Tamil, Tausug, Telugu, Tetum, Tharu, Tibetan, Tigrinya, Tripuri, Tswana, Tulu, Turkish, Tuwali, Ubi, Ukrainian, Urdu, Veps, Vietnamese, Wagdi, Waziri, Xhosa, Yiddish, Yoruba ["English", "French", "Arabic"]["en", "fr", "ar"]x >= 013
base64 encoded string
Show child attributes
x >= 1"Virginia Polytechnic Institute and State University (Virginia Tech)"
Show child attributes
"Bachelor of Science"
"Bachelor of Science, Mechanical Engineering, expected"
"Bachelor of Science"
"bachelors"
Show child attributes
"Blacksburg, VA"
"Blacksburg, VA, USA"
"3124"
"Virginia"
"TX"
"United States"
Two letter country code (ISO 3166-1 alpha-2)
"US"
"1"
"Smith St"
"12"
"Blacksburg"
"67.0124"
"67.0124"
"P.O. Box 123"
Prediction of the candidate's profession based on recent work experience
"Software Developer"
Linkedin account associated with the candidate
"https://www.linkedin.com/in/user-name"
Show child attributes
x >= 1"Sales and retail assistants"
"7111"
"Sales and retail assistants"
"General Motors"
"Automotive"
Show child attributes
"Blacksburg, VA"
"Blacksburg, VA, USA"
"3124"
"Virginia"
"TX"
"United States"
Two letter country code (ISO 3166-1 alpha-2)
"US"
"1"
"Smith St"
"12"
"Blacksburg"
"67.0124"
"67.0124"
"P.O. Box 123"
"Interned with supercar Development from May 2017 to August 2017."
Show child attributes
"2018-05-01"
"2018-08-01"
x >= 0"May-Aug '18"
Show child attributes
The raw (not normalized) job title pulled from the work experience entry
"Sr. Software Developer"
Mapped onto the EMSI job title taxonomy if a sufficiently close match exists.
"Software Developer"
EMSI id of the normalised job title.
"ETE2AD3A1C11B4EC9B"
None, Low, Mid, Upper "Low"
Show child attributes
SOC2020 classification for this job title
"Book-keepers, payroll managers and wages clerks"
SOC2020 minor group
"Administrative Occupations: Finance"
SOC2020 sub major group
"ADMINISTRATIVE OCCUPATIONS"
SOC2020 major group
"ADMINISTRATIVE AND SECRETARIAL OCCUPATIONS"
The 4 digit code representing the SOC2020 classification for this job title
1 <= x <= 99994122
The 4 digit code representing the SOC2020 classification for this job title
1 <= x <= 99994122
The 4 digit code representing the SOC2020 classification for this job title
1 <= x <= 99994122
The 4 digit code representing the SOC2020 classification for this job title
1 <= x <= 99994122
Show child attributes
x >= 1EMSI id of this skill.
"KS1218W78FGVPVP2KXPX"
"Applied Mechanics"
"2012-01-01"
x >= 012
"hard_skill"
x >= 010
0.057699221573302296
Show child attributes
"WorkExperience"
If this skill is extracted from a "workExperience" section, the "position" is the index of the work experience where this skill is found, with 0 being the first work experience, 1 being the second work experience, and so on.
x >= 00
If this skill is extracted from a "workExperience" section, the "workExperienceId" is the id of the work experience where this skill is found.
x >= 11234
["Certificate in AWS"][
"Tim Smith et al., Investigations of nanoparticles in the pathology of the human eye, Cell 2014"
]Show child attributes
"Stephen Smith"
"Stephen Smith, Team Member/Mentor, Company Power Generation: [email protected]"
"+61490667215"
"Principal"
Show child attributes
Probability that the given document is a resume. Values below 30 suggest that the document is not a resume.
0 <= x <= 10098
All of the raw text of the parsed resume, example is shortened for readability
"Christopher Nolan 3210 fake street '... <rest of resume text>'"
Redacted version of the text in the resume, removing PII.
"**** Objective: To obtain a job '... <rest of resume text>'"
For custom fields. E.g. 'isAvailable': true
Show child attributes
Unique identifier for the document
Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.
"46ab8b02-0e5b-420c-877c-8b678d46a834"
Optional filename of the file
"Document.pdf"
If true, the document has finished processing. Particularly useful if an endpoint request specified wait=False, when polling use this variable to determine when to stop polling
true
The datetime when the document was ready
"2020-12-10T01:43:32.276724Z"
If true, some exception was raised during processing. Check the 'error' field of the main return object.
false
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
The document's language.
"en"
The URL to the document's pdf (if the uploaded document is not already pdf, it's converted to pdf as part of the parsing process).
"https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
The document's pages.
Show child attributes
x >= 1Page number within the document, starts from 0.
x >= 00
The URL to the image of the page.
"https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
Height of the page's image in px.
700
Width of the page's image in px.
500
The degree of rotation applied to the page. Greater than 0 indicates clockwise rotation. Less than 0 indicates counter-clockwise rotation.
-360 <= x <= 36090
The URL to the translated image of the page.
"https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
This is true if the 'confirm' button has been clicked in the Affinda validation tool
false
Signed URL (valid for 60 minutes) to access the validation tool. Not applicable for documents types such a resumes.
"https://app.affinda.com/review/XJ5kK123?signature=12345"
The overall confidence in the conversion of image to text. (only applicable for images or PDF documents without a text layer)
0.97
"resume"
Show child attributes
A single alpha-2 country code (e.g. AU) used by google geocoding service
A list of alpha-2 country codes used by Pelias
A list of coordinates used by Pelias in the shape of [min_lon, min_lat, max_lon, max_lat]
If true, the location must be within the region, as opposed to prefering locations within the region. Default to false.
true