![Hyperproof.Io [Test] Help Center](https://downloads.intercomcdn.com/i/o/xgk1dxp2/757668/427b255f2659cc7e0853d6a00ec1/628914ae2617199b7d999ba797a5305a.png)
Hyperproof uses Merge, a third-party API, to retrieve data from HRIS apps. Hyperproof uses the Employees, Employments, and Groups scopes. If you are interested in learning more about the permissions needed for HRIS Hypersyncs that use Merge, refer to the Merge Authentication Guides page in their Help Center.
Note: This Hypersync is not supported in Hyperproof Gov.
When you configure a Hypersync for Folks HR on a control or label, you can automatically collect the following proof types:
Folks HR proof types and fields
Proof type | Fields | Testable |
Employees with Change in Employment Status | Name, Email, Department, Title, Status, Start Date, End Date | Yes |
List of Employees | Name, Email, Department, Title, Status, Start Date, End Date | Yes |
This Hypersync supports importing a company directory for an access review. See Importing a directory with a Hypersync for more information.
Blocking sensitive data
When Hyperproof connects to a Merge Hypersync, we intentionally minimize data exposure and follow least-privilege principles. Sensitive data can't be blocked entirely from within Hyperproof; it can only be blocked at the source. We recommend working with the System Administrator for the app you are accessing to configure a service account specifically for Hyperproof with access only to the data you need the Hypersync to collect.
Requirements
To connect to Folks HR and collect proof, your Folks HR configuration must meet the following requirements.
Client ID and Client Secret - To locate:
Log in to Folks HR.
Navigate to Admin > Company > API Key Management.
Click Generate new API key, enter a name, and click Generate.
Copy the Unique universal identifier and secret key and store them in a secure location.
Note: Hyperproof connects to many third-party systems that frequently change, including the system interface. Contact your System Administrator or the third-party provider for assistance in meeting the requirements to integrate with Hyperproof and collect the proof you need.
Connection configuration
Authentication type: Custom
Custom authentication parameters: Unique universal identifier, Secret key (also known as Client ID and Client Secret)
When you configure a Hypersync for Folks HR for the first time, you must provide the following information:
Unique universal identifier
Secret key
The first time you run this Hypersync, it may take up to 24 hours to load all employee data.
Note: You only need to connect Hyperproof to the app once, and then you can create as many Hypersyncs as you need.
Additionally, you can create multiple Hypersyncs for a single control or label.
Additional documentation
Connecting to Folks HR
From the left menu, select either Controls or Labels, depending on the object you want to link to the Hypersync.
Select the control or label for which you want to automate proof.
Select the Automations tab.
Click Create Hypersync.
The Choose app window opens.
Use the filter at the top of the Choose app window to find the app where the proof data will be pulled from, e.g., Azure or GitHub. You can search for apps by Name, App ID, or Category, such as Ticketing or Accounting apps.
Select your app.
The Connect window opens.
Note: Hyperproof uses Merge, a third-party API, to streamline the connection process. For more information on how Hyperproof integrates with Merge, please refer to the Hyperproof Security Overview.
Sign in to your account.
Note: Depending on the app, you might be asked for your username and password or a token. The sign-in process varies by app. See the Requirements and Connection configuration sections of the specific Hypersync document for more details.