The "Account settings" page allows admins to manage their Checkr accounts and individual users to manage their account settings.
Note
Your Checkr user permissions might show options that differ from this page. If you need access to an option, contact Checkr.
Use the Settings tab to edit your account settings.
Checkr populates the fields below while creating your account:
- Company name: This name appears in candidate-facing emails you send from this account as well as in the Candidate Portal for your candidates.
- URI name: This name appears in the links for your Candidates page, and you can't edit it.
- Account logo: This image appears in candidate-facing emails.
Enter information for the fields below:
- Support phone or email: Enter the phone number or email address that candidates use to submit evidence of rehabilitation or other context during the adverse action process.
- Billing email: Enter the address where Checkr will contact you about invoices and other billing communications. This email address can't log in to the Checkr Dashboard.
- Adverse action email: Enter the address that will send pre- and post-adverse action emails from you to candidates.
This address also receives the undeliverable notice if the candidate's email doesn’t work. If your adverse action email address can’t receive messages, Checkr emails your addresses in the order below:- User email for the account that initiated the adverse action process
- Adverse action email
- Support email
- Billing email
- Technical contact email
If none of these addresses work, the undeliverable notice goes to all users with at least admin account permissions.
- Technical contact email: If your company uses the Checkr API for integration, enter the person to contact for technical communications. Checkr uses this email address to contact your organization about important Checkr API issues or updates.
- Compliance contact email: Enter the person to communicate with Checkr about compliance issues or updates. Checkr uses this email address for updates about candidate disputes and changes to background check reports.
Manage account and candidate notifications
Set email notifications
Use the Notifications section to select the content and frequency of your automated email notifications. You can set email notification preferences at the user level. To receive these notices, your account must have at least one subscribed user.
Checkr can send emails about the topics below:
- All report updates: Receive an email for any changes to report status.
- All candidate updates: Receive an email when a candidate receives an invitation or an invitation expires.
- All candidate stories: Receive an email for every candidate story submission.
Notifications about more specific report and candidate events are also available. For example, you can receive email notifications about specific report status changes.
Set candidate notifications
Checkr sends both email and SMS notifications by default, and you can customize what candidates receive.
Disable candidate notifications
Notifications are critical in ensuring that candidates can submit information and complete their background checks promptly. Disable notifications only in the situations below:
- Disable candidate invitation emails only if you want to manually send candidates links to their background check invitations. Even if you disable email invitations, candidates still receive emails when Checkr needs information from the candidate.
- Disable all candidate SMS notifications only when you want to turn off all SMS communications that candidates receive.
Manage API keys and webhooks
The "Developer settings" tab provides access to your account’s API keys and webhooks. API keys enable API access to the Checkr service for customized interfaces. Webhooks provide account-level webhooks to which Checkr-generated events post.
API and webhook logs appear in the Logs page of the Checkr Dashboard.
For more information, refer to Webhooks in the Checkr API documentation.
Manage API keys
The "API keys" section lists active API keys for the account.
You can create both secret and publishable keys for your account. Use the secret keys in your staging and production environments. Keep your secret keys confidential, and store them only on your own servers.
For more information, refer to API keys in the Checkr API documentation.
Before you can access production keys, Checkr must credential your account for production API access. After credentialing, create and manage your API keys in the Developer settings tab.
To create a new key, select "Create key."
For existing keys, you can take two actions:
- Select the eye to show and hide the password.
- Select Expire to set an expiration date for the selected key.
Note
Never share your API keys via email or other unsecure means.
Add a new webhook
Use account webhooks to receive updates for objects created with the API. To get status updates, you must create webhook endpoints and add them in the Checkr Dashboard. Webhook endpoints have a limit of 2. If you try to create more than 2 endpoints in either environment, a "Quota limit exceeded" error appears.
For more information, refer to Webhooks in the Checkr API documentation.
The "Configured webhooks" section lists existing webhooks. Use the "New webhook" section to create a new webhook.
To add a new webhook for your account, use the steps below:
- In the "New webhook" section of the "Account settings" page, enter a URL that meets the requirements below:
- HTTP, HTTPS, and AWS SNS protocols are supported.
- Use HTTP only for test environment webhooks.
- HTTP and HTTPS endpoints must be publicly accessible.
- AWS SNS endpoint must follow the format:
`sns://<key_id>:<access_key>@<region>/<topic_owner>/<topic_name>`
- Select the Live environment.
- Select a jurisdiction: US or CA.
- Select the "Include related object in payload" checkbox if you want to.
- Select Add to create the new webhook.
To acknowledge receipt of a webhook, your endpoint should return a 2xx HTTP status code. Other information returned in the response header or response body is ignored.
If a webhook isn't received, Checkr continues trying to send it every minute for 10 minutes, then every hour for 24 hours.
Monitor webhook logs in the Logs page.
Note
These account-level webhooks aren't for existing partner or OAuth integrations. To update webhook URLs for a partner integration, contact Checkr.
After you create webhooks, you can subscribe to the updates you want.
For more information about available subscriptions, refer to Webhooks in the Checkr API documentation.
Manage partner applications
Use the "Application settings" tab to create and manage partner applications for your account.
To create a new partner application, select "New partner application."
Manage partner integrations
Use the Integrations tab to find and manage OAuth integrations enabled for your account.
To disable an integration for your account, select "Turn off."
Manage nodes
Nodes are customizable segments that help you manage your Checkr account. After you define nodes, you can assign them to users, packages, your adjudication matrix, and other aspects of your Checkr account. Checkr calls your account’s configuration of nodes a "hierarchy."
After your account has a hierarchy, you must maintain at least one node. You can edit a single remaining node in your account, but you can't delete it.
Create a node or parent node
To create a node or parent node, use the steps below:
- Below the list of nodes on the "Account hierarchy" tab, select Add Row.
- Enter a name and a custom ID for the node.
- In the fourth column, select a parent node. If you don't select a parent node, the node goes in your hierarchy's top level.
- Select Submit Hierarchy.
Create a node tier
To create a node tier, use the steps below:
- Below the list of nodes on the "Account hierarchy" tab, select Add Row.
- Enter a name and a custom ID for the node tier.
- In the third column, open the menu and enter the node name.
- In the fourth column, select a parent node.
- Select Submit Hierarchy.
Remove a node
To remove a node, select the trash can next to it.
Manage brands
You can use brands to customize candidate messaging by node. The Brands tab appears only for accounts that have a hierarchy with at least one node. After you create a brand and assign nodes, that brand appears on candidate invitations for that node. The brand also appears on the screens where candidates submit information. Your account can have multiple brands.
Create a brand
Use the Brands tab to create brands for your account. A brand needs a website and logo to appear in your candidate communications.
To create a brand, use the steps below:
- Enter a name.
- Enter the website for the brand.
- Upload a logo, and select "Add brand." Checkr accepts all image file types, and suggests a minimum size of 160x160 pixels.
- Your brand appears in the "Manage brands" section.
Assign nodes to brands
Assign nodes to brands to customize candidate communication by your account's nodes.
To assign a node to a brand, use the steps below:
- From the "Manage brands" list, select "Assign nodes."
- Select nodes for your brand, and select Save.
- Confirm your selection.