Skip to main content

Candidate Profile Schema

When RAISE successfully processes a resume, it publishes a CandidateProfileCreated event to the SQS output queue and/or stores it in DynamoDB, depending on your output target configuration.

This page documents the complete schema of that event.

Event Envelope​

FieldTypeRequiredDescription
idstring (uuid)✅Unique identifier for this event
fileNamestring✅The name of the source resume file (e.g. resumes/john-doe.pdf)
timestampstring (date-time)✅ISO 8601 date-time when the event was published
analysisResult.candidateProfileobject✅The structured candidate profile extracted from the resume

Candidate Profile Fields​

Required Fields​

FieldTypeDescription
fullNamestringThe candidate's full name
emailstring (email)The candidate's email address
workExperiencearrayEmployment history — see Work Experience
educationarrayEducational background — see Education

Optional Fields​

FieldTypeDescription
phoneNumberstringContact phone number
locationstringGeographic location of the candidate
professionalSummarystringSummary of the candidate's professional background
skillsarrayList of skills — see Skills
certificationsarrayList of certifications — see Certifications

Nested Objects​

Work Experience​

Each entry in the workExperience array contains:

FieldTypeRequiredDescription
companyNamestring✅Name of the employer
positionstring✅Job title or role
startDatestring✅Start date of employment
endDatestringNoEnd date of employment
isCurrentPositionbooleanNotrue if this is the candidate's current role
responsibilitiesarray of strings✅List of responsibilities in this role

Education​

Each entry in the education array contains:

FieldTypeRequiredDescription
institutionstring✅Name of the educational institution
qualificationstring✅Degree or qualification obtained
fieldOfStudystringNoMajor or field of study
yearstringNoYear the qualification was attained

Skills​

Each entry in the skills array contains:

FieldTypeRequiredDescription
skillstring✅A specific skill or competency

Certifications​

Each entry in the certifications array contains:

FieldTypeRequiredDescription
certificationstring✅Name of the certification
yearstringNoYear the certification was attained

Full Example​

{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"fileName": "resumes/jane-smith.pdf",
"timestamp": "2026-03-29T08:30:00.000Z",
"analysisResult": {
"candidateProfile": {
"fullName": "Jane Smith",
"email": "jane.smith@example.com",
"phoneNumber": "+27 82 123 4567",
"location": "Johannesburg, South Africa",
"professionalSummary": "Senior software engineer with 8 years of experience building cloud-native applications on AWS.",
"workExperience": [
{
"companyName": "Acme Financial Services",
"position": "Senior Software Engineer",
"startDate": "2021-03",
"isCurrentPosition": true,
"responsibilities": [
"Designed and built microservices on AWS Lambda and ECS",
"Led a team of 4 engineers across two product squads",
"Reduced API response times by 40% through caching improvements"
]
},
{
"companyName": "Tech Startup Ltd",
"position": "Software Engineer",
"startDate": "2018-06",
"endDate": "2021-02",
"isCurrentPosition": false,
"responsibilities": [
"Built RESTful APIs using Node.js and TypeScript",
"Maintained CI/CD pipelines on GitHub Actions"
]
}
],
"education": [
{
"institution": "University of the Witwatersrand",
"qualification": "BSc Computer Science",
"fieldOfStudy": "Computer Science",
"year": "2018"
}
],
"skills": [
{ "skill": "TypeScript" },
{ "skill": "AWS Lambda" },
{ "skill": "Node.js" },
{ "skill": "DynamoDB" }
],
"certifications": [
{ "certification": "AWS Certified Solutions Architect – Associate", "year": "2022" },
{ "certification": "AWS Certified Developer – Associate", "year": "2023" }
]
}
}
}