Skip to main content

Authorization

Follow this guide to create a new Factorial credential that will allow Nexla to authenticate to and exchange data with your Factorial HR account.
factorial_api_auth.png

Factorial

Prerequisites​

To connect Nexla to Factorial, you will need a Factorial API key. API keys are generated by workspace administrators from within the Factorial platform.

Generate a Factorial API Key​

Only Factorial workspace administrators can create API keys. Complete the following steps to generate an API key for use with Nexla:

  1. Sign in to your Factorial workspace as an administrator at https://app.factorialhr.com.

  2. In the left sidebar, navigate to Configuration.

  3. Under the Configuration section, select API.

  4. Click the button to create a new API key. Enter a descriptive name for the key (for example, "Nexla Integration") to make it easy to identify later.

  5. After the key is generated, copy it immediately and store it in a secure location. Factorial displays the API key only once—it cannot be retrieved again after you leave the page.

Important

The Factorial API key grants access to all data in your workspace and cannot be scoped to specific resources. Store the key securely and treat it with the same care as a password. If the key is compromised, delete it from the Factorial Configuration → API page and generate a new one.

Determine Your API Version​

Factorial uses a date-based API versioning scheme in the format YYYY-MM-DD. A new version is released at the beginning of each quarter (approximately January 1, April 1, July 1, and October 1), and each version is supported for one year.

The default version configured in this connector is 2026-04-01. Review the Factorial API versioning documentation and the Factorial API changelog to confirm the appropriate version for your integration and update it if a newer version is available.

Create a Factorial Credential​

  • To create a new Factorial credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

  1. Enter the Factorial API key you generated in the API Key field. This key is sent as the X-API-KEY header on every request Nexla makes to the Factorial API, authenticating the connection to your workspace.

    Nexla validates the API key when the credential is saved by making a test request to the Factorial credentials endpoint. If validation fails, verify that the key was copied correctly and that the account has administrator-level access in Factorial.

  2. Enter the Factorial API version in the API Version field. The default value is 2026-04-01. This version string is embedded in the URL path of every API request (for example, https://api.factorialhr.com/api/2026-04-01/resources/...). Update this value when Factorial releases a new quarterly version and you are ready to migrate your integration.

    Factorial releases a new API version each quarter and supports each version for one year. Additional details about the versioning schedule and migration guidance are available in the Factorial API versioning documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.