HrFlow.ai (Preview)
HrFlow.ai is the 1st multi-layer AI powered API that brings intelligence to your HR Data and bridges the gap between all your data Sources and Destinations.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | HrFlow.ai |
| URL | https://www.hrflow.ai |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | HrFlow.ai |
| Website | https://www.hrflow.ai |
| Privacy policy | https://security.hrflow.ai/ |
| Categories | AI;Website |
https://www.HrFlow.ai is an API first company that provides the most sophisticated AI Powered JOB & PROFILE API. Corporates and Software vendors can leverage our technology layers to Parse, Enrich and Score both job and candidate data.
- Our Developers documentation : https://developers.hrflow.ai/
- Our API list (Parsing, Revealing, Embedding, Searching, Scoring, Reasoning) : https://www.hrflow.ai/api
- Our cool demos labs : https://labs.hrflow.ai
This connector will allow our partners and customers to build and automate on top of HrFlow.ai's technology, complex and different workflows using Power Automate.
Prerequisites
- Sign Up for an HrFlow.ai Account.
- Log In with your account details.
- API Key select from Settings >> API >> Keys your API key.
How to get credentials
You will need to retrieve an API key to use with this connector by following these instructions.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | Get an API Key from HrFlow.ai | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Post a document Profile for sync or async parsing |
The Profile API helps you connect HrFlow.ai with the applications of your choice. Mainly, the API allows you to POST profiles and GET outbound data after the processing of choice is done. |
| Post an HR document for parsing |
The Document API is a general purpose API design for real-time processing of HR documents. |
Post a document Profile for sync or async parsing
The Profile API helps you connect HrFlow.ai with the applications of your choice. Mainly, the API allows you to POST profiles and GET outbound data after the processing of choice is done.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
x-user-email.
|
x-user-email | True |
HrFlow.ai user's email. |
|
|
file.
|
file | True | file |
The file to upload. |
|
source_key.
|
source_key | True | string |
The key of the source in which the Profile will be added. |
|
key.
|
key | string |
Profile's unique identifier it is used when you want to override an existing Parsing object. |
|
|
reference.
|
reference | string |
Profile's reference it is a unique value for a given source. |
|
|
created_at.
|
created_at | date-time |
The Creation datetime in iso format |
|
|
sync_parsing.
|
sync_parsing | integer |
To enable sync parsing you set this value to 1 otherwise the value is 0. |
|
|
sync_parsing_indexing.
|
sync_parsing_indexing | integer |
This parameter is used when you are using sync parsing it enables Profile indexing so this object will be available using search engine. The default value is 0 |
|
|
webhook_parsing_sending.
|
webhook_parsing_sending | integer |
To enable the reception of webhook notification after parsing and before indexing you set the value to 1. The default value is 0. |
|
|
labels.
|
labels | string |
The Profile's labels to include with the object. |
|
|
tags.
|
tags | string |
The Profile's tags aims to mark uploaded object. |
|
|
metadatas.
|
metadatas | string |
The Profile's metadata. |
Returns
Post an HR document for parsing
The Document API is a general purpose API design for real-time processing of HR documents.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
HrFlow.ai user's email.
|
x-user-email | True | string |
HrFlow.ai user's email. |
|
text
|
text | string |
Text to be parsed. |
Returns
Definitions
Date
| Name | Path | Type | Description |
|---|---|---|---|
|
iso8601
|
iso8601 | date-time |
The datetime in iso8601 format. |
|
text
|
text | string |
The parsed date as found in the document. |
|
timestamp
|
timestamp | integer |
The date as timestamp. Measured in seconds since the Unix epoch. |
Person
| Name | Path | Type | Description |
|---|---|---|---|
|
full_name
|
full_name | string |
The person's full name. |
|
first_name
|
first_name | string |
The person's first name. |
|
last_name
|
last_name | string |
The person's last name. |
Skill
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
The skill's name. |
|
type
|
type | string |
Either hard or soft. |
|
value
|
value | integer |
It measures the confidence level of expertise. |
Language
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
The language's name. |
|
value
|
value | integer |
The language's value measuring language's expertise'. |
Interest
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
The interest's name. |
|
value
|
value | integer |
The interest's value it measures the confidence level of expertise. |
Label
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
job_key | string |
The Job's key that you want to record the stage. |
|
job_reference
|
job_reference | string |
The Job's reference. |
|
stage
|
stage | string |
The stage (ie. yes/no/later/new) for the given job. |
|
rating
|
rating | string |
The interest's value it measures the confidence level of expertise. |
|
date_stage
|
date_stage | date-time |
Time at which the stage was last updated. |
|
date_rating
|
date_rating | date-time |
Time at which the rating was last updated. |
Tag
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
The tag's name. |
|
value
|
value | string |
The tag's value. |
Metadata
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
The metadata's name. |
|
value
|
value | string |
The metadata's value. |
Location
| Name | Path | Type | Description |
|---|---|---|---|
|
text
|
text | string |
The detected location information as found in the document. |
|
lat
|
lat | string |
The location's latitude. |
|
lng
|
lng | string |
The location's longitude. |
|
geojson
|
geojson | object |
The geojson object gives more details about location street number / city / country .... |
Education
| Name | Path | Type | Description |
|---|---|---|---|
|
content_uid
|
content_uid | string |
The object's content uid. |
|
title
|
title | string |
The education's title. |
|
school
|
school | string |
The education's school. |
|
description
|
description | string |
The education's description. |
|
date_start
|
date_start | Date | |
|
date_end
|
date_end | Date | |
|
location
|
location | Location |
Experience
| Name | Path | Type | Description |
|---|---|---|---|
|
content_uid
|
content_uid | string |
The experience's content uid. |
|
title
|
title | string |
The experience's title. |
|
company
|
company | string |
The experience's school. |
|
description
|
description | string |
The experience's description. |
|
date_start
|
date_start | Date | |
|
date_end
|
date_end | Date | |
|
location
|
location | Location |
Attachment
| Name | Path | Type | Description |
|---|---|---|---|
|
content_uid
|
alt | string |
The file hash id the value is calculated based on the file's binary. |
|
updated_at
|
updated_at | date-time |
Time at which the object was last updated. |
|
created_at
|
created_at | string |
Time at which the object was created. |
|
extension
|
extension | string |
The attachment's extension. |
|
file_name
|
file_name | string |
The attachment's name. |
|
file_size
|
file_size | string |
The attachment's size. |
|
original_file_name
|
original_file_name | string |
The attachment's original name. |
|
public_url
|
public_url | string |
The attachment's url One of "resume"/"cover"/"other". |
|
type
|
type | string |
The attachment's type its value can be one from this set (resume/cover/other). |
Profile
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The object's id. |
|
key
|
key | string |
Unique identifier for the object. |
|
reference
|
reference | string |
The profile's reference it must be unique for a given source. |
|
archive
|
archive | date-time |
The date when a profile is archived if the profile is not archived archive will be null. |
|
consent_algorithmic
|
consent_algorithmic | object |
The user's algorithmic consent it tells to the algorithm what are the allowed actions in order to use personal data. |
|
source
|
source | object |
The source to which the profile belongs. |
|
updated_at
|
updated_at | date-time |
Time at which the object was last updated. |
|
created_at
|
created_at | string |
Time at which the object was created. |
|
info
|
info | object |
The Profile's info it contains all personal information such as first/last name email phone. |
|
text
|
text | string |
The Profile's text it contains a long resume of a profile it is generated based on parsed text. |
|
text_language
|
text_language | string |
The original language of the document. |
|
educations
|
educations | array of Education |
A list of Educations object education is identified by a unique key. |
|
educations_duration
|
educations_duration | number |
Education's duration. |
|
experiences
|
experiences | array of Experience |
A list of Experiences object experience is identified by a unique key. |
|
experiences_duration
|
experiences_duration | number |
Experience's duration it calculates the profile's seniority. |
|
attachments
|
attachments | array of Attachment |
A list of profile's Attachments object. |
|
skills
|
skills | array of Skill |
A list of profile's Skills object. |
|
languages
|
languages | array of Language |
A list of profile's Languagse object. |
|
interests
|
interests | array of Interest |
A list of profile's Interests object. |
|
labels
|
labels | array of Label |
A list of Labels object that you can attach to an object. |
|
tags
|
tags | array of Tag |
A list of Tags object that you can include with an object. This can be helpful in attaching tags to a profile. |
|
metadatas
|
metadatas | array of Metadata |
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 forma. |
Parsing
| Name | Path | Type | Description |
|---|---|---|---|
|
content_uid
|
content_uid | string |
The object's content uid. |
|
key
|
key | string |
Unique identifier for the object. |
|
file name
|
file name | string |
The original uploaded file name. |
|
file size
|
file size | string |
The original uploaded file size. |
|
persons
|
persons | array of Person |
A list of all parsed Persons. |
|
emails
|
emails | array of email |
This field records all existing emails in a document.. |
|
phones
|
phones | array of string |
Time at which the object was last updated. |
|
birthdate
|
birthdate | Date | |
|
certifications
|
certifications | array of string |
A list of Profile's certifications. |
|
courses
|
courses | array of string |
A list of followed courses. |
|
tasks
|
tasks | array of string |
A list of Profile's tasks through every educations / experiences. |
|
location
|
location | Location | |
|
images
|
images | array of string |
A list of URLs for all detected images. |
|
picture
|
picture | string |
The url of profile's picture. |
|
urls
|
urls | array of object |
The urls for linkedin / twitter / facebook / github if they exist. |
|
items
|
urls | object | |
|
gender
|
gender | string |
The Profile's gender. |
|
driving_license
|
driving_license | string |
The Profile's driving license if exits otherwise the default value is null. |
|
summary
|
summary | string |
The Profile's summary. |
|
text
|
text | string |
The Profile's text it contains a long resume of a profile it is generated based on parsed text. |
|
text_language
|
text_language | string |
The original language of the document. |
|
educations
|
educations | array of Education |
A list of Educations object education is identified by a unique key. |
|
educations_duration
|
educations_duration | number |
Education's duration. |
|
experiences
|
experiences | array of Experience |
A list of Experiences object experience is identified by a unique key. |
|
experiences_duration
|
experiences_duration | number |
Experience's duration it calculates the profile's seniority. |
|
skills
|
skills | array of Skill |
A list of profile's Skills object. |
|
languages
|
languages | array of Language |
A list of profile's Languagse object. |
|
interests
|
interests | array of Interest |
A list of profile's Interests object. |
|
processed_pages
|
processed_pages | integer |
Number of processed pages. |
|
total_pages
|
total_pages | integer |
Document total pages. |
Entity
| Name | Path | Type | Description |
|---|---|---|---|
|
end
|
end | integer |
end. |
|
start
|
start | integer |
start. |
|
label
|
label | string |
label. |
ProfileSyncParsingResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
HTTP status code. |
|
message
|
message | string |
Profile parsed successfully. Profile extraction finished x.xx seconds. |
|
parsing
|
data.parsing | Parsing | |
|
profile
|
data.profile | Profile |
DocumentParsingResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | integer |
HTTP status code. |
|
message
|
message | string |
Parsing results. |
|
ents
|
data.ents | array of Entity |
All parsed entities. |
|
text
|
data.text | string |
Original text. |