Candidate Entity

Overview

This page describes the format and data for a candidate record that you should expect to be able to use when Integrating with CandidateHub.

This is the standard format we expect to receive from all partners sending candidates into our system.

For partners receiving candidates from us, you should also expect to receive this format, however it is worth being aware that this is not a fixed schema.

CandidateHub has a list of Plugins available to help cater for client/partner specific requirements when receiving candidate data ( e.g. populating additional structured data from parsing of the candidates CV attachment ). The broad intent is that we attempt to fit any additional data into this structure but at times we will need to extend this definition to accommodate specific use cases or requirements.

This standard list of data may be extended in the future to include additional commonly requested data.

{
    "name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "tronan@applicant.com",
    "contact_telephone": "5555555555",
    "mobile_telephone": "5555555555",
    "location_city": "Austin, TX",
    "location_country": "US",
    "location_postcode": "78758",
    "location_latitude": "51.803398",
    "location_longitude": "-0.564736",
    "current_job_title": "Customer Success Manager",
    "current_job_employer": "CircleBack Inc",
    "current_job_startdate": "2013-07-01T12:00:00",
    "documents": [
      {
       "filename": "John_Doe.pdf",
       "type": "cv",
       "content": "<REDACTED Base64 CV content>"
      },
      {
       "filename": "cover_letter.txt",
       "type": "coverletter",
       "content": "<REDACTED Base64 coverletter content>"
      }
   ]
}