Welcome to the new Affinda Docs – explore the Academy, browse guides, or ask the AI assistant any questions you have!
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": [
"timsmith@vt.edu"
],
"dateOfBirth": "1992-01-01",
"location": {
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"rawInput": "Blacksburg, VA",
"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": {
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"rawInput": "Blacksburg, VA",
"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": {
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"rawInput": "Blacksburg, VA",
"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: stephen.smith@company.com",
"email": "stephen.smith@company.com",
"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",
"imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"height": 700,
"width": 500,
"rotation": 90
}
],
"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": [
"timsmith@vt.edu"
],
"dateOfBirth": "1992-01-01",
"location": {
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"rawInput": "Blacksburg, VA",
"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": {
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"rawInput": "Blacksburg, VA",
"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": {
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"rawInput": "Blacksburg, VA",
"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: stephen.smith@company.com",
"email": "stephen.smith@company.com",
"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",
"imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"height": 700,
"width": 500,
"rotation": 90
}
],
"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
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
The response is of type object
.