Profile JSON
Hrflow.ai profile JSON object.

Profile

The Profile object is a standard representation of a candidate, aims to improve Object Hr Management.
It is a faster / readable data structure helping developers to cover many Hr use cases.
The API allows you to create, update and retrieve your profile.

The Profile Object

1
{ 'id': 'profile_id',
2
'key': 'profile_key',
3
'reference': 'profile_reference',
4
'archive': null,
5
'consent_algorithmic': {'controller': {'embedding': true,
6
'parsing': true,
7
'reasoning': false,
8
'revealing': false,
9
'scoring': true,
10
'searching': false},
11
'owner': {'embedding': true,
12
'parsing': true,
13
'reasoning': false,
14
'revealing': false,
15
'scoring': true,
16
'searching': false}},
17
'source': {'id': 'source_id',
18
'key': 'source_key',
19
'name': 'async source',
20
'subtype': 'http',
21
'type': 'api'},
22
'updated_at': '2020-09-11T10:26:36+0000',
23
'created_at': '2020-08-06T10:09:47+0000',
24
'info': { 'email': '[email protected]',
25
'first_name': 'Harry',
26
'full_name': 'Harry Potter',
27
'last_name': 'Potter',
28
'date_birth': '1990-08-09T00:00:00+0000'
29
'gender': 'male',
30
'location': {'fields': {
31
"category": null,
32
"city": "Paris",
33
"city_district": "8e Arrondissement",
34
"country": "FRA",
35
"country_region": null,
36
"entrance": null,
37
"house": null,
38
"house_number": "18",
39
"island": null,
40
"level": null,
41
"near": null,
42
"po_box": null,
43
"postcode": "75008",
44
"road": "Rue Daru",
45
"staircase": null,
46
"state": "Ile-de-France",
47
"state_district": "Paris",
48
"suburb": "8e Arrondissement",
49
"text": "18 Rue Daru, 75008 Paris, France",
50
"unit": null,
51
"world_region": null
52
},
53
'gmaps': null,
54
'lat': null,
55
'lng': null,
56
'text': null},
57
'phone': '0202',
58
'picture': 'picture public url',
59
'summary': 'Brief summary',
60
'urls': [{
61
"type": "from_resume",
62
"url": []
63
},
64
{
65
"type": "linkedin",
66
"url": null
67
},
68
{
69
"type": "twitter",
70
"url": null
71
},
72
{
73
"type": "facebook",
74
"url": null
75
},
76
{
77
"type": "github",
78
"url": null
79
}]
80
},
81
'text': 'Profile s text',
82
'text_language': 'en',
83
'educations': [{ 'key': 'education_key',
84
'title': 'Mathematicien',
85
'school': 'University',
86
'description': 'Education s description',
87
'date_start': '2016-01-01T00:00:00',
88
'date_end': '2018-01-01T00:00:00',
89
'location': {'fields': {
90
'category': null,
91
'city': 'Paris',
92
'city_district': null,
93
'country': 'FRA',
94
'country_region': null,
95
'entrance': null,
96
'house': null,
97
'house_number': null,
98
'island': null,
99
'level': null,
100
'near': null,
101
'po_box': null,
102
'postcode': '75001',
103
'road': null,
104
'staircase': null,
105
'state': 'Ile-de-France',
106
'state_district': 'Paris',
107
'suburb': null,
108
'text': 'Paris, Ile-de-France, France',
109
'unit': null,
110
'world_region': null
111
},
112
'gmaps': null,
113
'lat': null,
114
'lng': null,
115
'text': 'Scotland'},
116
'certifications': [{'name': 'certificate edu', 'value': null}],
117
'courses': [{'name': 'course edu', 'value': null}],
118
'tasks': [{'name': 'task edu', 'value': null}],
119
'skills': [{'name': 'skill edu', 'type' : 'hard', 'value': null}]
120
}],
121
'educations_duration': 2,
122
'experiences': [{ 'key': 'experience_key',
123
'title': 'Data scientist',
124
'company': 'Mathematic Departement',
125
'description': 'Experience s description.',
126
'date_start': '2018-01-01T00:00:00',
127
'date_end': '2018-07-01T00:00:00',
128
'location': {'fields': {
129
"category": null,
130
"city": "Saclay",
131
"city_district": null,
132
"country": "FRA",
133
"country_region": null,
134
"entrance": null,
135
"house": null,
136
"house_number": null,
137
"island": null,
138
"level": null,
139
"near": null,
140
"po_box": null,
141
"postcode": "91400",
142
"road": "Rue de Paris",
143
"staircase": null,
144
"state": "Ile-de-France",
145
"state_district": "Essonne",
146
"suburb": null,
147
"text": "Rue de Paris, 91400 Saclay, France",
148
"unit": null,
149
"world_region": null
150
},
151
'gmaps': null,
152
'lat': null,
153
'lng': null,
154
'text': 'Paris'},
155
'certifications': [{'name': 'certificate exp', 'value': null}],
156
'courses': [{'name': 'course exp', 'value': null}],
157
'tasks': [{'name': 'task exp', 'value': null}],
158
'skills': [{'name': 'skill exp', 'type' : 'hard', 'value': null}]
159
}],
160
'experiences_duration': 0.7,
161
'attachments': [{
162
'alt': 'alt_resume',
163
'created_at': '2020-09-11T10:26:29+0000',
164
'extension': '.pdf',
165
'file_name': 'resume',
166
'file_size': 528305,
167
'original_file_name': 'resume',
168
'public_url': 'https://riminder-documents-eu-2019-12.s3-eu-west-1.amazonaws.com/resume.pdf',
169
'type': 'resume',
170
'updated_at': '2020-09-11T10:26:29+0000'},
171
{
172
'alt': 'alt_original',
173
'created_at': '2020-09-11T10:26:29+0000',
174
'extension': '.pdf',
175
'file_name': 'original',
176
'file_size': 537789,
177
'original_file_name': 'original',
178
'public_url': 'https://riminder-documents-eu-2019-12.s3-eu-west-1.amazonaws.com/original.pdf',
179
'type': 'original',
180
'updated_at': '2020-09-11T10:26:29+0000'}],
181
'certifications': [
182
{'name': 'certificate', 'value': null}
183
],
184
'courses': [
185
{'name': 'course', 'value': null}
186
],
187
'tasks': [
188
{'name': 'task', 'value': null}}
189
],
190
'skills': [{'name': 'manual skill', 'value': null, 'type': 'hard'},
191
{'name': 'Creative spirit', 'value': null, 'type': 'soft'},
192
{'name': 'Writing skills', 'value': null, 'type': 'hard'},
193
{'name': 'Communication', 'value': null, 'type': 'soft'}],
194
'languages': [{'name': 'english', 'value': null}],
195
'interests': [{'name': 'football', 'value': null}],
196
'labels': [{'job_key': 'job_key', 'stage': 'yes'}],
197
'tags': [{'name':'archive', 'value': true}],
198
'metadatas': [{'name':'personal-email', 'value': '[email protected]'}]}
Copied!

Attributes

name
description
id
The object's id
key
Unique identifier for the object
reference
The profile's reference, it must be unique for a given source
archive
The date when a profile is archived, if the profile is not archived archive will be null
consent_algorithmic
The user's algorithmic consent, it tells to the algorithm what are the allowed actions in order to use personal data
source
The source to which the profile belongs
updated_at
Time at which the object was last updated
created_at
Time at which the object was created
info
The Profile's Info object, it contains all personal information such as first/last name email, phone
text
The Profile's text, it contains a long resume of a profile, it is generated based on parsed text
text_language
The original language of the document
educations
A list of Educations object, education is identified by a unique key
educations_duration
Education's duration
experiences
A list of Experiences object, experience is identified by a unique key
experiences_duration
Experience's duration, it calculates the profile's seniority
attachments
A list of profile's Attachments object
certifications
A list of profile's Certifications object
courses
A list of profile's Courses object
tasks
A list of profile's Tasks object
skills
A list of profile's Skills object
languages
A list of profile's Languagse object
interests
A list of profile's Interests object
labels
A list of Labels object that you can attach to an object
tags
A list of Tags object that you can include with an object. This can be helpful in attaching tags to a profile
metadatas
A list of Metadata object that you can include with an object. This can be useful for storing additional information about the object in a structured format
Last modified 4mo ago