Skip to main content

SmartRecruiters proof types and permissions

Written by Hyperproof Support
Updated this week

Hyperproof uses Merge, a third-party API, to retrieve data from applicant tracking apps. Hyperproof uses the Application:Read , Candidate:Read, Job:Read, JobInterviewStage:Read, RejectReason:Read, and Remote:User scopes. If you are interested in learning more about the permissions needed for applicant tracking 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 SmartRecruiters on a control or label, you can automatically collect the following proof types:

SmartRecruiters proof types and fields

Proof type

Fields

Testable

Application Lifecycle Summary

Candidate Name, Candidate Email, Job Title, Current Stage, Source, Credited To, Updated

Yes

User Account Lifecycle

Name, Email, Access Role, Active, Updated, Deleted, Remote ID

Yes

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 SmartRecruiters and collect proof, your SmartRecruiters configuration must meet the following requirements.

  • You must be a SmartRecruiters administrator.

  • API Key - You only need your API key if you don't plan to use your own credentials to connect to SmartRecruiters. To locate:

    1. Log in to SmartRecruiters, click your name, then select Settings /Admin from the dropdown menu.

    2. Select Apps & Integrations under Administration.

    3. Select Credentials in the upper menu.

    4. Click New Credential and select API key.

    5. Add a name and description for the API key, and select Generate.

    6. Copy the API Key and store it in a secure location.

  • Company ID - To locate:

    1. Log in to SmartRecruiters as an administrator.

    2. Select Settings/Admin and click Career Pages & Job Ads.

    3. Your company ID displays in the URL after the / in https://careers.smartrecruiters.com/.

    4. Copy the company ID and store it 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: Email and Password, or API Key and Company ID

When you configure a Hypersync for SmartRecruiters for the first time, you must provide the following information:

  • Use my credentials (recommended)

    • Email

    • Password

  • Use my API key or access token

    • API Key

    • Company ID

The first time you run this Hypersync, it may take up to 24 hours to load all 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 SmartRecruiters

  1. From the left menu, select either Controls or Labels, depending on the object you want to link to the Hypersync.

  2. Select the control or label for which you want to automate proof.

  3. Select the Automations tab.

  4. Click Create Hypersync.

    The Choose app window opens.

  5. 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.

  6. 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.

  7. 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.

Did this answer your question?