📖 The Profile Object

Profile Object

Field	Type	Description
`key`	`string` Required	Identification key of the Profile.
`reference`	`string` Required	Custom identifier of the Profile.
`info`	Info Required	Object containing the Profile's info.
`text_language`	`string code ISO 639-1` Required	Code language of the Profile.
`text`	`string` Required	Full text of the Profile.
`consent_algorithmic`	Consent Algorithmic	Algorithmic consent status of the Profile.
`archived_at`	`datetime ISO 8601`	Archive date of the Profile. The value is `null` for unarchived Profiles.
`updated_at`	`datetime ISO 8601`	Last update date of the Profile.
`created_at`	`datetime ISO 8601`	Creation date of the Profile.
`experiences_duration`	`float`	Total number of years of experience.
`educations_duration`	`float`	Total number of years of education.
`experiences`	Experiences	List of experiences of the Profile.
`educations`	Educations	List of educations of the Profile.
`attachments`	Attachments	List of documents attached to the Profile.
`skills`	Skills	List of skills of the Profile.
`languages`	Languages	List of spoken languages of the Profile.
`certifications`	Certifications	List of certifications of the Profile.
`courses`	Courses	List of courses of the Profile.
`tasks`	Tasks	List of tasks of the Profile.
`interests`	Interests	List of interests of the Profile.
`tags`	Tags	List of tags of the Profile.
`metadatas`	Metadatas	List of metadatas of the Profile.
`labels`	Labels	List of labels of the Profile.

Info of the Profile

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

Field	Type	Description
`full_name`	`string`	Profile full name.
`first_name`	`string`	Profile first name.
`last_name`	`string`	Profile last name.
`email`	`string`	Profile email.
`phone`	`string`	Profile phone number.
`date_birth`	`datetime ISO 8601`	Profile date of birth.
`location`	Location	Profile location object.
`urls`	URLs	Profile social networks and URLs.
`picture`	`string`	Profile picture URL.
`gender`	`string`	Profile gender ( `male` or `female` ).
`summary`	`string`	Profile summary text.

Experiences

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

Field	Type	Description
`key`	`string`	Identification key of the Experience.
`company`	`string`	Company name of the Experience.
`logo`	`string`	Logo of the Company
`title`	`string`	Title of the Experience.
`description`	`string`	Description of the Experience.
`location`	Location	Location object of the Experience.
`date_start`	`datetime ISO 8601`	Start date of the experience.
`date_end`	`datetime ISO 8601`	End date of the experience.
`skills`	Skills	List of skills of the Experience.
`certifications`	Certifications	List of certifications of the Experience.
`courses`	Courses	List of courses of the Experience.
`tasks`	Tasks	List of tasks of the Experience.

Educations

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

Field	Type	Description
`key`	`string`	Identification key of the Education.
`school`	`string`	Company name of the Education.
`logo`	`string`	Logo of the School
`title`	`string`	Title of the Education.
`description`	`string`	Description of the Education.
`location`	Location	Location object of the Education.
`date_start`	`datetime ISO 8601`	Start date of the Education.
`date_end`	`datetime ISO 8601`	End date of the Education.
`skills`	Skills	List of skills of the Education.
`certifications`	Certifications	List of certifications of the Education.
`courses`	Courses	List of courses of the Education.
`tasks`	Tasks	List of tasks of the Education.

Consent Algorithmic

The consent_algorithmic object of the Profile contains 2 sub-objects:

owner: describes the data processing consent of the Profile data for the Profile itself as a Data Owner
controller: describes the data processing consent of the Profile data for the Receiver of the Profile as a Data Controller (example: company or recruiter).

Field	Type	Description
`owner.parsing`	`string`	Parsing processing consent for the Data Owner.
`owner.revealing`	`string`	Revealing processing consent for the Data Owner.
`owner.embedding`	`string`	Embedding processing consent for the Data Owner.
`owner.searching`	`string`	Searching processing consent for the Data Owner.
`owner.scoring`	`string`	Scoring processing consent for the Data Owner.
`owner.upskilling`	`string`	Upskilling processing consent for the Data Owner.
`controller.parsing`	`string`	Parsing processing consent for the Data Controller.
`controller.revealing`	`string`	Revealing processing consent for the Data Controller.
`controller.embedding`	`string`	Embedding processing consent for the Data Controller.
`controller.searching`	`string`	Searching processing consent for the Data Controller.
`controller.scoring`	`string`	Scoring processing consent for the Data Controller.
`controller.upskilling`	`string`	Upskilling processing consent for the 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": []
    }
  ],
  "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": []
    }
  ],
  "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": []
}