❓Why❓

Candidate data is often unstructured (e.g., raw text, resumes), making it difficult to standardize.

HrFlow.ai parsing APIs make it easy for you to structure candidate data. Our API returns a structured JSON object named Profile.

🛠️ How to implement 🛠️

The implementation will vary depending on whether you're extracting profile data from resumes or raw text.

🎓

Prerequisites

1. Create an account
2. Activate your account: you need to activate either Profile Parsing API or Text Parsing API depending on your need
3. API Authentification
4. Create a source

1. I need to parse data from resumes - 95% of use cases

You need to use our Profile Parsing API.

1. Create a source and retrieve its key.
2. Use the Profile Parsing API with the source key and the resume in binary format.

Note: by default, our Profile Parsing API is asynchronous. That means you won't directly receive a Profile object in the response: instead, the profile will be indexed in the source once parsing is done. If you need synchronous parsing, please get in touch.

3. Optional Retrieve the parsed profile: if you want to retrieve the profile you just parsed, you have two options:
   1. Use synchronous parsing: you'll get the Profile object in the response. Synchronous parsing is supported by all our parsing models except Chronos.
   2. Use a webhook: create a webhook with type parsing.profile.success: as soon as a profile is successfully parsed, a request is sent to the URL provided in the webhook.

2. I need to parse data from raw text

You need to use our Text Parsing API.

1. Create a source and retrieve its key.
2. Use the Text Parsing API and set parameter output_object to profile to retrieve a Profile object.
3. Store the parsed Profile object in the appropriate source using our Profile Indexing API.

🎨 Customization 🎨

• You can enrich the Profileobject with tags and metadatas to add more information that is not available from the resume file. Tags are designed to be short and searchable, unlike metadata. More information about tags and metadata here.
• If each profile already has a unique reference in your system (outside HrFlow.ai), you can set reference field on the Profile object.