πŸ“– The Profile Object

Fields' description and JSON of the Profile Object.

Profile Object

FieldTypeDescription
keystring RequiredIdentification key of the Profile.
referencestring RequiredCustom identifier of the Profile.
infoInfo RequiredObject containing the Profile's info.
text_languagestring ISO 639-1 RequiredCode language of the Profile.
textstring RequiredFull text of the Profile.
consent_algorithmicConsent AlgorithmicAlgorithmic consent status of the Profile.
archived_atdatetime ISO 8601Archive date of the Profile. Null if not archived.
updated_atdatetime ISO 8601Last update date of the Profile.
created_atdatetime ISO 8601Creation date of the Profile.
experiences_durationfloatTotal number of years of experience.
educations_durationfloatTotal number of years of education.
experiencesExperiencesList of experiences of the Profile.
educationsEducationsList of educations of the Profile.
attachmentsAttachmentsList of documents attached to the Profile.
skillsSkillsList of skills of the Profile.
languagesLanguagesList of spoken languages of the Profile.
certificationsCertificationsList of certifications of the Profile.
coursesCoursesList of courses of the Profile.
tasksTasksList of tasks of the Profile.
interestsInterestsList of interests of the Profile.
tagsTagsList of tags of the Profile.
metadatasMetadatasList of metadatas of the Profile.
labelsLabelsList of labels of the Profile.

Info of the Profile

Info is an object accessible via the field info and follows the structure below:

FieldTypeDescription
full_namestringProfile full name.
first_namestringProfile first name.
last_namestringProfile last name.
emailstringProfile email.
phonestringProfile phone number.
date_birthdatetime ISO 8601Profile date of birth.
locationLocationProfile location object.
urlsURLsProfile social URLs.
picturestringProfile picture URL.
genderstringProfile gender: male or female.
summarystringProfile summary text.

Experiences

Experiences is an array of objects accessible via the field experiences and follows the structure below:

FieldTypeDescription
keystringIdentification key of the Experience.
companystringCompany name of the Experience.
logostringLogo of the company.
titlestringTitle of the Experience.
descriptionstringDescription of the Experience.
locationLocationLocation object of the Experience.
date_startdatetime ISO 8601Start date of the Experience.
date_enddatetime ISO 8601End date of the Experience.
skillsSkillsList of skills used in the Experience.
certificationsCertificationsList of certifications gained.
coursesCoursesList of courses completed.
tasksTasksTasks performed during the Experience.
languagesLanguagesLanguages used in the Experience.
interestsInterestsRelated interests during the Experience.

Educations

Educations is an array of objects accessible via the field educations and follows the structure below:

FieldTypeDescription
keystringIdentification key of the Education.
schoolstringSchool or university name.
logostringLogo of the school.
titlestringTitle or degree of the Education.
descriptionstringDescription of the Education.
locationLocationLocation object of the Education.
date_startdatetime ISO 8601Start date of the Education.
date_enddatetime ISO 8601End date of the Education.
skillsSkillsList of skills gained during the Education.
certificationsCertificationsCertifications acquired.
coursesCoursesCourses taken.
tasksTasksTasks completed.
languagesLanguagesLanguages studied.
interestsInterestsRelated interests.

Consent Algorithmic

The consent_algorithmic object contains 2 sub-objects:

  • owner: Data Owner’s consent for processing their own profile.
  • controller: Data Controller’s consent (e.g. recruiter/company).
FieldTypeDescription
owner.parsingstringParsing consent for Data Owner.
owner.revealingstringRevealing consent for Data Owner.
owner.embeddingstringEmbedding consent for Data Owner.
owner.searchingstringSearching consent for Data Owner.
owner.scoringstringScoring consent for Data Owner.
owner.upskillingstringUpskilling consent for Data Owner.
controller.parsingstringParsing consent for Data Controller.
controller.revealingstringRevealing consent for Data Controller.
controller.embeddingstringEmbedding consent for Data Controller.
controller.searchingstringSearching consent for Data Controller.
controller.scoringstringScoring consent for Data Controller.
controller.upskillingstringUpskilling consent for Data Controller.

Example of Profile JSON

{
  "key": "8af2b7a0b48fbc936ace283ec020b0d6d4c4b018",
  "reference": null,
  "consent_algorithmic": {
    "owner": {
      "parsing": true,
      "revealing": false,
      "embedding": true,
      "searching": true,
      "scoring": true,
      "reasoning": false
    },
    "controller": {
      "parsing": true,
      "revealing": false,
      "embedding": true,
      "searching": true,
      "scoring": true,
      "reasoning": false
    }
  },
  "archived_at": null,
  "updated_at": "2021-12-10T15:18:46+0000",
  "created_at": "2021-12-10T15:18:46+0000",
  "info": {
    "full_name": "Harry James Potter",
    "first_name": "Harry James",
    "last_name": "Potter",
    "email": "[email protected]",
    "phone": "0747532699",
    "date_birth": "1997-06-26T00:00:00+0000",
    "location": {
      "text": "Number 4, Privet Drive, Little Whinging",
      "lat": null,
      "lng": null,
      "gmaps": null,
      "fields": null
    },
    "urls": [
      {"type": "from_resume", "url" : "https://hrflow.ai/"},
      {"type": "from_resume", "url" : "https://developers.hrflow.ai/"},
      {"type": "linkedin", "url" : "https://fr.linkedin.com/doe-john"},
      {"type": "linkedin", "url" : "https://fr.linkedin.com/doe-jane"},
      {"type": "twitter", "url" : "https://twitter.com/hrflowai"},
      {"type": "facebook", "url" : "https://www.facebook.com/hrflowai/"},  
      {"type": "github", "url" : "https://github.com/harry-james-potter"}
  ],
    "picture": null,
    "gender": "male",
    "summary": "Sorcerer Apprentice"
  },
  "text_language": "en",
  "text": "Harry James Potter\nSorcerer Apprentice\n\ndate of birth: June 26th 1997\nNumber 4, Privet Drive, Little Whinging\nemail: [email protected]\nphone: 0747532699\n\nExperiences\n\nApril 2002 - July 2002\tHogwarts School of Witchcraft and Wizardry\nMagic Investigator\nSolving mysteries about the Sorcerer's stone.\nteamplayer, empathy.\n\nEducations\n\nDecember 2001 - December 2002\tHogwarts School of Witchcraft and Wizardry\nSorcerer Apprentice\nFirst year of study.\nwitchcraft, levitation, lycanthropy.\n\nSkills\n\nwitchcraft\ndark arts\nperseverance\nempathy\n\nInterests\n\nquidditch\nwizard chess",
  "experiences_duration": 0.25,
  "educations_duration": 1,
  "experiences": [
    {
      "key": "8af2b7a0b48fbc936ace283ec020b0d6d4c4b019",
      "company": "Hogwarts School of Witchcraft and Wizardry",
      "logo": null,
      "title": "Magic Investigator",
      "description": "Solving mysteries about the Sorcerer's stone.",
      "location": {
        "text": "Hogwarts",
        "lat": null,
        "lng": null,
        "gmaps": null,
        "fields": null
      },
      "date_start": "2002-04-01T00:00:00+0000",
      "date_end": "2002-07-01T00:00:00+0000",
      "skills": [
        {
          "name": "teamplayer",
          "type": "soft",
          "value": null
        },
        {
          "name": "empathy",
          "type": "soft",
          "value": null
        }
      ],
      "certifications": [],
      "courses": [],
      "tasks": [],
      "languages": [],
      "interests": []
    }
  ],
  "educations": [
    {
      "key": "8af2b7a0b48fbc936ace283ec020b0d6d4c4b020",
      "school": "Hogwarts School of Witchcraft and Wizardry",
      "logo": null,
      "title": "Sorcerer Apprentice",
      "description": "First year of study.",
      "location": {
        "text": "Hogwarts",
        "lat": null,
        "lng": null,
        "gmaps": null,
        "fields": null
      },
      "date_start": "2001-12-01T00:00:00+0000",
      "date_end": "2002-12-01T00:00:00+0000",
      "skills": [
        {
          "name": "witchcraft",
          "type": "hard",
          "value": null
        },
        {
          "name": "levitation",
          "type": "hard",
          "value": null
        },
        {
          "name": "lycanthropy",
          "type": "hard",
          "value": null
        }
      ],
      "certifications": [],
      "courses": [],
      "tasks": [],
      "languages": [],
      "interests": []
    }
  ],
  "attachments": [],
  "skills": [
    {
      "name": "witchcraft",
      "type": "hard",
      "value": null
    },
    {
      "name": "dark arts",
      "type": "hard",
      "value": null
    },
    {
      "name": "perseverance",
      "type": "soft",
      "value": null
    },
    {
      "name": "empathy",
      "type": "soft",
      "value": null
    }
  ],
  "languages": [],
  "certifications": [],
  "courses": [],
  "tasks": [],
  "interests": [
    {
      "name": "quidditch",
      "value": null
    },
    {
      "name": "wizard chess",
      "value": null
    }
  ],
  "labels": [],
  "tags": [
    {
      "name": "contract_type",
      "value": "Full Time"
    }
  ],
  "metadatas": []
}