Skip to main content

How do I connect my Humaans account?

This guide will outline the steps needed to create the API key, link it with Ledgy and configure the sync between the two platforms.

Written by Support Team

What is your integration use case?

  • I have not created any stakeholder profiles in my Ledgy account

  • I have already created stakeholder profiles in my Ledgy account


Use case 1: I have not created any stakeholder profiles in my Ledgy account.

1. Connect Humaans with Ledgy

First, go to Company Settings > Data Management > HR system integration > Connect.

Scenario 1: Existing connection

If you’re already connected — there is nothing to do! Feel free to jump to ‘Configure your HRIS field import into Ledgy

If you are connected, but wish to adjust your API key permissions or change HRIS provider, please ‘disconnect’ and follow the new connection instructions, or reach out to customer support.


Scenario 2: Establishing a new connection / no existing connection

1.1 Select Humaans from the HR system logo picker and click the Connect button


1.2 Generate your Humanns' API Key

Step 1: To generate an API key for a Humaans.io integration, start by logging into the platform.

Step 2: From the sidebar, click the three dots to extend the drop-down menu. Click "API access tokens".

Step 3: Create or edit an existing API Key.

  • If you have an existing API key, you can use the edit button to update the scopes on the key. Skip to Step 5

  • If you do not have an existing key, use the "Generate new token" button to create a new key:

    Could not display content

Step 4: Configure the scopes you will need for your integration.

At a minimum Ledgy will need "View public data" to retrieve basic employee data.

  • Enabling "View public data" allows us to map information including:

    • Email

    • Employment Status

    • Team

  • Enabling "View public and private data" allows us to map information including:

    • Personal Email

    • Birthdate

    • Home address (written in Ledgy's "Address Line 1" field)

    • City

    • ZIP Code

      • In Ledgy's "Address" fields, we concat "Home address, ZIP Code City"

    • Country

    • Employment Date

    • Employment Type

  • Enabling "View compensations" allows us to read information, including:

    • Pay Currency

    • Pay Period

Please note the permissions listed above are the minimal required permissions for the reading capability of the employee fields in HiBob so that we can map the default fields in Ledgy.

Fields mapped by default (Simple)

  • Identifier

  • Name

  • Email (i.e work email)

  • Personal Email

  • Address Line 1

  • Address Line 2

  • ZIP Code

  • City

  • Country

  • Birthdate

  • Group Name

  • Start Date (not visible on stakeholder modal)

  • Termination Date (not visible on stakeholder modal)

  • Employment Status (not visible on stakeholder modal)

  • Pay Rate (not visible on stakeholder modal)

  • Pay Period (not visible on stakeholder modal)

  • Pay Currency (not visible on stakeholder modal)

  • Employment Type (not visible on stakeholder modal)

  • Team (not visible on stakeholder modal)

If you don't want to share specific data points with Ledgy, you do not need to include those!


1.3 Link your Humaans account with Ledgy

Paste your Humaans API Key and click on Submit.

You’ll be given the option to map additional HR field mappings from your HRIS into Ledgy. Hit ‘Skip for now’ and request additional field mappings via the in-app chat, once linking is complete.


2. Configure your HRIS field import into Ledgy

You need to configure the fields before initiating sync. Hit ‘Configure’ to open up the modal below. You are able to change the configuration later and at any future point.

Nb. please close & re-open the modal to first load the configure screen. Loading may take up to 5 minutes.

2.1. Stakeholder identifier should be a unique identifier, and the value should exist for all employees in HRIS. In Humaans case, the identifier is “Work email”.

  • If you already have stakeholders in Ledgy, please see FAQ below.

2.2. Stakeholder email: Choose which employee field to map to Ledgy’s primary email.

2.3. Additional fields to import allow you to optionally import any of the following fields:

  • Manager

  • Mobile Phone Number

  • Pay Rate

2.4. Hover over the “❓ Some basic stakeholder fields” to see the default fields mapped from HRIS into Ledgy

2.5. For Humaans, it is not possible to add additional fields to Ledgy from your HRIS.

2.6. You can add "Sync if" conditions to specify which employees to sync in Ledgy.

⚠️ Note: filters are additive, meaning that stakeholders must match all conditions for a rule to apply to them. You can use ‘OR’ conditions to select multiple values for a given filter. For example: you may want to sync employees across multiple countries, and multiple groups.


3. Syncing stakeholders into Ledgy

Once you have setup the configuration, you can sync stakeholders. Hit ‘sync’ to preview stakeholders that will be created or updated in Ledgy.

Nb. ‘Mobile number’ will appear as invalid if the country code is not inputted in HRIS. Please add country code to HRIS entries to successfully sync mobile number - otherwise, this will need to be manually updated in Ledgy.


Use case 2: I have already created stakeholder profiles in my Ledgy account.

1. Connect Humaans with Ledgy

First, go to Company Settings > Data Management > HR system integration > Connect.

Scenario 1: Existing connection

If you’re already connected — there is nothing to do! Feel free to jump to ‘Configure your HRIS field import into Ledgy

If you are connected, but wish to adjust your API key permissions or change HRIS provider, please ‘disconnect’ and follow the new connection instructions, or reach out to customer support.


Scenario 2: Establishing a new connection / no existing connection

1.1 Select Humaans from the HR system logo picker and click the Connect button


1.2 Generate your Humanns' API Key

Step 1: To generate an API key for a Humaans.io integration, start by logging into the platform.

Step 2: From the sidebar, click the three dots to extend the drop-down menu. Click "API access tokens".

Step 3: Create or edit an existing API Key.

  • If you have an existing API key, you can use the edit button to update the scopes on the key. Skip to Step 5

  • If you do not have an existing key, use the "Generate new token" button to create a new key:

Step 4: Configure the scopes you will need for your integration.

At a minimum Ledgy will need "View public data" to retrieve basic employee data.

  • Enabling "View public data" allows us to map information including:

    • Email

    • Employment Status

    • Team

  • Enabling "View public and private data" allows us to map information including:

    • Personal Email

    • Birthdate

    • Home address (written in Ledgy's "Address Line 1" field)

    • City

    • ZIP Code

      • In Ledgy's "Address" fields, we concat "Home address, ZIP Code City"

    • Country

    • Employment Date

    • Employment Type

  • Enabling "View compensations" allows us to read information, including:

    • Pay Currency

    • Pay Period

Please note the permissions listed above are the minimal required permissions for the reading capability of the employee fields in HiBob so that we can map the default fields in Ledgy.

Fields mapped by default (Simple)

  • Identifier

  • Name

  • Email (i.e work email)

  • Personal Email

  • Address Line 1

  • Address Line 2

  • ZIP Code

  • City

  • Country

  • Birthdate

  • Group Name

  • Start Date (not visible on stakeholder modal)

  • Termination Date (not visible on stakeholder modal)

  • Employment Status (not visible on stakeholder modal)

  • Pay Rate (not visible on stakeholder modal)

  • Pay Period (not visible on stakeholder modal)

  • Pay Currency (not visible on stakeholder modal)

  • Employment Type (not visible on stakeholder modal)

  • Team (not visible on stakeholder modal)

If you don't want to share specific data points with Ledgy, you do not need to include those!


1.3 Link your Humaans account with Ledgy

Paste your Humaans API Key and click on Submit.

You’ll be given the option to map additional HR field mappings from your HRIS into Ledgy. Hit ‘Skip for now’ and request additional field mappings via the in-app chat, once linking is complete.


2. Configure your HRIS field import into Ledgy

You need to configure the fields before initiating sync. Hit ‘Configure’ to open up the modal below. You are able to change the configuration later and at any future point.

Nb. please close & re-open the modal to first load the configure screen. Loading may take up to 5 minutes.

2.1. Stakeholder identifier should be a unique identifier, and the value should exist for all employees in HRIS. In Humaans case, the identifier is “Work email”.

2.2. Stakeholder email: Choose which employee field to map to Ledgy’s primary email.

2.3. Additional fields to import allow you to optionally import any of the following fields:

  • Manager

  • Mobile Phone Number

  • Pay Rate

2.4. Hover over the “❓ Some basic stakeholder fields” to see the default fields mapped from HRIS into Ledgy

2.5. For Humaans, it is not possible to add additional fields to Ledgy from your HRIS.

2.6. You can add "Sync if" conditions to specify which employees to sync in Ledgy.

⚠️ Note: filters are additive, meaning that stakeholders must match all conditions for a rule to apply to them. You can use ‘OR’ conditions to select multiple values for a given filter. For example: you may want to sync employees across multiple countries, and multiple groups.

2.7. Update your stakeholders:

  1. To edit your stakeholder in bulk, go to Stakeholders > click the "Bulk" button

  2. Select "Natural person" > Click on the "Stakeholders" button to download your stakeholder list

  3. Add the unique identifier "Work email" for each stakeholder from your HRIS Platform in the Identifier column in the Excel file

  4. Upload the Excel file back to your account


3. Syncing stakeholders into Ledgy

Once you have setup the configuration, you can sync stakeholders. Hit ‘sync’ to preview stakeholders that will be created or updated in Ledgy.

Nb. ‘Mobile number’ will appear as invalid if the country code is not inputted in HRIS. Please add country code to HRIS entries to successfully sync mobile number - otherwise, this will need to be manually updated in Ledgy.


FAQ

Which HRIS fields are mapped into Ledgy?

By default, we now map more data from your HRIS into Ledgy, and you can select from optional fields to also map into Ledgy.

Fields mapped by default (Simple)

  • Identifier

  • Name

  • Email (i.e work email)

  • Personal Email

  • Address Line 1

  • Address Line 2

  • ZIP Code

  • City

  • Country

  • Birthdate

  • Group Name

  • Start Date (not visible on stakeholder modal)

  • Termination Date (not visible on stakeholder modal)

  • Employment Status (not visible on stakeholder modal)

  • Pay Rate (not visible on stakeholder modal)

  • Pay Period (not visible on stakeholder modal)

  • Pay Currency (not visible on stakeholder modal)

  • Employment Type (not visible on stakeholder modal)

  • Team (not visible on stakeholder modal)

Nb. Depending on the permissions, some default fields will not be mapped.

For fields that are not supported by default by your HRIS, please follow FAQ for How do I setup HR field mappings from my HRIS into Ledgy?”, to request the field mapping via support chat. You can then map the field mapping into a Ledgy custom field.


Why can I only see partial data for my synced stakeholders?

Oh no! Possible reason:

  • The API key that is used for authentication has permission restrictions.

If this issue cannot be resolved by changing the API key permission or by adding the missing field via a custom field (see FAQ for How do I setup HR field mappings from my HRIS into Ledgy?) - you can manually input field value in Ledgy for a Stakeholder, or via bulk excel.


How do I setup HR field mappings from my HRIS into Ledgy?

In Humaans case, it is not possible to map custom fields with your Ledgy account.


What are Ledgy custom fields?

Ledgy stakeholder custom fields are company-wide fields that you create in Ledgy. They exist on each stakeholder.


What if I already have stakeholders in Ledgy, and now want to sync with HRIS?

Ledgy requires a Stakeholder identifier to match existing stakeholders in Ledgy with employees in HRIS. If no identifiers exist in Ledgy and the names do not match 100% between your HRIS platform and Ledgy, then duplicates may be created in Ledgy in the syncing process.

If you have created your stakeholders without your HRIS platform in your Ledgy account and now wish to connect your HRIS platform, please follow the steps to ensure that the sync doesn't create duplicate stakeholders.

Update your stakeholders:

  1. To edit your stakeholder in bulk, go to Stakeholders > click the "Bulk" button

  2. Select "Natural person" > Click on the "Stakeholders" button to download your stakeholder list

  3. Add the unique identifier "Work email" for each stakeholder from your HRIS Platform in the Identifier column in the Excel file

  4. Upload the Excel file back to your account

Correct mapping:

  1. Follow the step 1 and step 2 in the integration process

  2. Go to Company Settings > Data Management > HR System Integration > Click the "Configure" button

  3. Map the name of the identifier that you added in the Excel file with the Ledgy field "Stakeholder identifier"

  4. Click the "Save" button to save the mapping

Now you can sync Ledgy with your HRIS platform, and we will not create any duplicates!


Can I still use this page without connecting my HRIS?

You can still use the Data Management page to manage your stakeholder’s custom fields.


What happens when an employee is terminated on the HRIS?

When a termination date is synced from your HRIS to Ledgy, the stakeholder is flagged with a Leaver tag. This prompts admins to review whether offboarding action is needed in Ledgy.

There are then two paths to take:

  • If offboarding action is needed, offboard the stakeholder in Ledgy.

  • If these are historical leavers and no offboarding action is needed, clear those statuses from the Stakeholders grid: select the relevant rows, open the overflow menu, and click Clear status.

When using Clear status, selected rows that do not currently have a status tag are skipped.

If you do not want inactive or terminated employees to be included in future syncs, you can also add a "Sync if" condition such as syncing only employees whose status is active. This excludes inactive employees from future syncs, but does not offboard stakeholders who already exist in Ledgy.

Did this answer your question?