Checkr
Checkr (opens in a new tab) allows you to programmatically manage candidates, including all their details. This allows you to process candidate users at scale.
Prerequisites
In order to integrate with Checkr, you'll need to collect the following information:
You will also need to provide a Checkr API key secret value. This value can be determined by logging into Checkr with the desired account. Once logged in;
Navigate to the Account section from the options available on the left hand side
Select Developer settings tab
Here you can view your API Keys and their secret values
NOTE The access action of this integration uses an endpoint which is limited to users with a US work location.
Name | Description |
---|---|
Domain* | The Checkr API domain (default = api.checkr.com) |
Checkr API key secret value* | Your Checkr API key secret value. Please see the Checkr API documentation regarding authentication for more details (opens in a new tab) |
Integrating with Checkr
To integrate an existing system with Checkr:
- Navigate to Data map → View Systems and choose the system that you want to connect.
- Click on the Integrations tab.
- Pick the vendor or system type that you want to integrate with from the Connection type drop-down menu.
- Complete the required fields for the integration and click Save.
You may confirm your connection is working using the Test connection button, if desired.
To learn more, please see our guide for Managing Integrations.
Technical detail
Fides utilizes API endpoints to access the API service for a SaaS application. An API service is the programmatic interface through which Fides can query and update data within an application to access, rectify, or delete personal information. Each SaaS tool will have a unique set of endpoints to enable privacy functions.
Checkr Endpoints
In the table below, you can find which endpoints are used for each type of privacy function. Clicking on the endpoint will take you to the documentation for that endpoint.
Privacy function | Endpoint | Description |
---|---|---|
Access Requests | List Candidates (opens in a new tab) | Lists existing Candidates with the input parameters. Note: This call will not return candidates with non-US work_locations. |
Update or Delete Requests | Request PII removal for a Candidate (opens in a new tab) | Requests the removal of PII from an existing Candidate. |
By default, deletion requests are fulfilled by masking personal information. To enable Fides to personal information, ensure the masking_strict
variable in your fides.toml
file is set to false
.