![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 Darwinbox on a control or label, you can automatically collect the following proof types:
Darwinbox 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 Darwinbox and collect proof, your Darwinbox configuration must meet the following requirements.
You must be a Darwinbox administrator.
Subdomain - The subdomain for your Darwinbox account. For example, if you sign in at
https://acme.darwinbox.com, acme is your subdomain.
Reach out to your Darwinbox representative and ask for the following:
Username
Password
Access to the Fetch Employee Data (Full Load) API Endpoint
API Key and Dataset Key for All Active Employees
API Key and Dataset Key for All Inactive Employees
Enable the following employee data fields in the masterapi:
employee_id
department_name
designation_name
first_name
last_name
date_of_activation
latest_modified_timestamp
department_code
group_company_code
business_unit
business_unit_code
company_email_id
direct_manager_employee_id
full_name
date_of_joining
employee_status
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: Subdomain, Username, Password, Active Employees API Key, Active Employees Dataset Key, Inactive Employees API Key, Inactive Employees Dataset Key
When you configure a Hypersync for Darwinbox for the first time, you must provide the following information:
Account data - Choose Production or Sandbox data.
Subdomain
Username
Password
Active Employees API Key
Active Employees Dataset Key
Inactive Employees API Key
Inactive Employees Dataset 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 Darwinbox
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.