|Please note: These Account Hierarchy User Guides are for our customers who have Account Hierarchy Management enabled. If your account is not yet using this feature, please refer to our Checkr Dashboard User Guides.|
The Account settings page allows admins to manage their Checkr account and individual users to manage their account settings. Use this page to:
- Define email addresses for notifications
- Set notification preferences
- Add new users to the account
- Add and edit user permissions
- View and configure SSO settings
- Add and manage API keys and account webhooks
- Review partner integrations
- Create brands
- Define a simple account hierarchy
You might see options that differ from those on this page depending on your Checkr user permissions. If you can't access an option you need, contact your Checkr Customer Success representative.
Use the Account settings > Settings tab to edit account settings for your organization and select email notification preferences at the user level.
Enter your company information
Checkr populates the fields below while enabling your account"
- Company name: This name appears in any candidate-facing emails issued from this account, as well as in the Candidate Portal for your candidates.
- URI name: This slug will be used in the links for your Candidates page.
- Account logo: This image appears in candidate-facing emails.
Define email addresses for notifications
As part of the background check process, Checkr issues multiple email notifications to candidates. Use the Account settings section to define these email addresses.
Email addresses must link to your company and can link to a shared email account so that multiple people within your company can monitor and respond to these requests and replies.
Enter an address for the following fields:
- Support phone: Enter the phone number that candidates can use to contact you to submit evidence of rehabilitation or other context during the adverse action process.
- Support email: Enter the address for candidates to use to contact you to submit evidence of rehabilitation or other context during the adverse action process.
- Billing email: Enter the address that Checkr will use to contact you about invoices and other billing communications.
- Adverse action email: Enter the address that will send pre- and post-adverse action notices on your behalf to candidates. This address receives the undeliverable notices if an adverse action notice is undeliverable to a candidate, which happens if their email account has expired or the email address on file is inaccurate.
- Technical contact email: If your company uses the Checkr APIs for integration, enter your primary person to contact for technical communications. Checkr uses this email address to contact you about important issues or updates to the Checkr APIs.
- Compliance contact email: Enter the primary person to communicate with Checkr about compliance issues or updates. Checkr uses this email address to send updates to candidate disputes or notifications of changes to background check reports.
Adverse action fallback
If your adverse action email address is invalid, Checkr will try to notify you using the following sequence of email addresses in the Account settings tab.
- User email for the account that initiated the adverse action
- Adverse action email
- Support email
- Billing email
- Technical contact email
If no email address exists at the account level, the email notifying your company that the adverse action email is undeliverable will be sent to the listed email address for all users on the Checkr account with admin permission level or above.
Set notification preferences
Use the Notifications section in the Account settings tab to select the content and frequency of your automated email notifications. This section of the page is available to all users of your Checkr account.
The following notifications are available:
- All report updates: Receive an email for any changes to report status.
- Report created: Receive an email each time a new background report is created.
- Report clear: Receive an email when a report completes with a Clear status.
- Report consider: Receive an email when a report completes with a Consider status, indicating that the report has something for you to review.
- Report suspended: Receive an email when a report is suspended, meaning that Checkr contacted the candidate to provide additional information but the candidate hasn't responded yet.
- Report canceled: Receive an email when a report is canceled, meaning that all screenings in the report were canceled.
- Report disputed: Receive an email when a report is disputed, meaning a candidate has contacted Checkr to contest the report's accuracy. Checkr initiates a re-investigation for these candidates. At least 1 user must be subscribed at all times to receive these notices.
- All candidate updates: Receive an email when a candidate invitation is sent or expires.
- Candidate invitation expired: Receive an email when an invitation has expired because the candidate didn't complete the process within 7 days or the customer-specified period.
- Candidate invitation sent: Receive an email every time an invitation is sent to a candidate.
- All Candidate Stories: Receive an email every time a candidate story is submitted.
- Candidate stories submitted pre/post AA: Receive an email if a candidate story is submitted before an adverse action is initiated, or after the pre-adverse action notice has been sent.
Customers with the Assess feature have the additional options below:
- All report assessment updates: Receive an email for all changes to any report assessment.
- Report assessment Eligible: Receive an email when a report assessment changes to Eligible.
- Report assessment Review: Receive an email when a report assessment changes to Review.
- Report assessment Escalated: Receive an email when a report assessment changes to Escalated.
- Report assessments (daily digest): Receive a daily email itemizing all changes to report assessments.
Use the Users tab to view, edit, manage, or delete existing users, or to invite new users to your Checkr account.
Best practices suggest that you maintain at least 2 admin accounts for your organization. If there is only 1 admin account and that person leaves your company unexpectedly, no one will be able to access the Checkr Dashboard and manage your account.
If the account has no admin, contact Checkr Customer Success to create one.
Invite new users
To add a user, enter their email address in the Enter email field and click Add user. Checkr sends an invitation to the user to confirm the new account creation and set up a password.
Checkr can't add users to your account. To protect against unexpected changes within your company, create multiple admin users for the account.
Assign roles to users
Click Edit in the Roles column to assign roles to your users and grant them permissions within the Checkr Dashboard.
Individual users can have multiple roles, such as adjudicator and requester.
Available user roles
- Limited user: This user role can access the candidates list but can't access candidate or report details. All new users on an account automatically have this role.
- Requester: This user role can access, send, monitor, and cancel invitations to initiate background checks. This role can add a screening to an existing package. Requesters can see the status of reports in the Candidates page but not the results of completed reports. Requesters can also access candidate documents and exceptions but not completed report details. Assign this role to recruiters who initiate background checks.
- Adjudicator: This user role can access candidate and report details. This role can adjudicate reports, engage candidates, and send pre-adverse action notices to candidates. Assign this role to adjudication staff.
- Restricted admin: This user role is available for Account Hierarchy-enabled accounts only. This role has all permissions of adjudicators and requesters for candidates in their Account Hierarchy node. This role can invite users to the account, add screenings, save packages, and assign non-admin user roles. This role can also view invoices and change developer settings. This role can't update billing or settings. Assign this role to administrators for sub-nodes on your account.
- Admin: This user role has full access to all functionality in the Checkr Dashboard. Admins can update account settings (including billing information), add screenings, save packages, and assign all roles to any users in the account. Admins aren't restricted by the nodes assigned to them. Limit this role to core members of your team.
For security purposes, Checkr can't adjust user permissions. Contact your team's admin to edit or add user roles for an account. By default, the first user on an account will always be an admin.
Assign nodes to users
Assign nodes to users to restrict their access to reports included in that node. Use this feature to streamline and manage your users’ account access. For example, nodes can be used to limit readable personally identifiable information (PII) for specific users, manage adjudication loads across multiple groups, or define access to candidate data.
This option is available only for those accounts with node-based restriction enabled. Work with your Checkr Customer Success agent to enable this for your account.
To use nodes to restrict user permissions, use the steps below:
- Select Assign Nodes from the menu.
- Use the options to select nodes to assign to or un-assign from the user.
- Review your selection, and click Yes to confirm.
For more information, refer to Assign nodes to packages in the Packages page of the User Guide.
To delete existing users from your account, click the red trash icon next to their name. Checkr issues a confirmation and then deletes the user from your account.
Unlock user accounts
Users with too many failed login attempts will be locked out of their accounts. To send a user a password-reset email, click Unlock User from the menu next to their name.
Single Sign On (SSO)
Use the Checkr Dashboard to find and update your SSO settings. Log in to your account as a user with the Checkr admin role. Then, go to Account settings > Single Sign On.
Copy your Checkr information into your IdP SAML config
Paste the listed values into your IdP endpoint setup.
- Strategy: SAML
- Single Sign On URL: Paste in the ACS URL field in your IdP’s SAML config.
- Audience: Paste in the SP Entity ID field in your IdP’s SAML config.
- Attributes: `email` Configure your IdP to send the email address for a user as the SAML Subject. (If you are setting up SP-initiated SSO, you must make sure that all emails sent via this attribute match the domain specified on the Checkr Dashboard under Email Domain.)
- Subject:NameID: Your IdP’s UUID or GUID.
Copy your SAML information into your Checkr setup
Use the following section to enter the required information.
- Sign in URL: The IdP callback endpoint (IdP URL) from your IdP platform’s SAML configuration. (Required for both IdP-initiated and SP-initiated SSO.)
- Email domain: Enter your email domain. All traffic within Checkr for users with this email domain will be directed to your SSO endpoint. This setting disables Checkr direct login. (Required only for Service Provider initiated SSO.)
Enabling this forces SP-Initiated SSO. Make sure that you’ve tested IdP-initiated SSO and make sure you meet the criteria to enable SP-enabled SSO before enabling!
- Signing certificate: Click Choose File to upload a signing certificate from your SAML provider to your Checkr account. Your IdP will use this public certificate to sign the assertion. (Your IdP Public Key (IdP Certificate) from your IdP platform’s SAML configuration.)
The Developer settings page provides access to your account’s API keys and sebhooks. API keys are used to enable API access to the Checkr service for customized interfaces. Webhooks provide account-level webhooks to which any Checkr-generated events will be posted.
API and webhook logs appear in the Logs section of the Checkr Dashboard.
For more information about webhooks, refer to the Checkr API Guide.
The API Keys pane lists all active API keys for the account:
- Click Show key to see the selected key in plain text.
- Click Expire key to set an expiration date for the selected key.
- Click Create new key to create new Live Secrets, Test Secrets, Live Publishable Tokens, or Test Publishable Tokens.
By default, customers are provided test API keys when their account is created. You will not gain access to production keys until Checkr credentials your account for production API access. Once your account is credentialed, go to Account settings > Developer settings to create and manage your API keys.
Use Test Secrets and Tokens while testing your integration. Test API calls are free, and will return fake data. When you’re ready, work with Checkr Customer Success to generate production Secrets and Tokens, and go live with your integration.
Use account webhooks to receive updates on objects created with the API. You must create webhook endpoints and add them in the Checkr dashboard to get status updates. You can create 2 endpoints within the test, and 2 within the live environment.
Attempts to create more than 2 endpoints within either environment will result in a "Quota limit exceeded" error.
For more information, refer to Webhooks in the Checkr API documentation.
The Account Webhooks section lists existing and allows you to create new webhooks.
To add a new webhook for your account, use the steps below:
- Enter a URL.
- HTTP, HTTPS, and AWS SNS schemes are supported.
- HTTP can be added only for Test environment webhooks.
- HTTP and HTTPS endpoints must be publicly accessible.
- AWS SNS endpoint must follow the format:
- Select an environment: Live or Test.
- Choose to Include related object in payload, if desired.
- Click +Add to create the new webhook.
To acknowledge receipt of a webhook, your endpoint should return a 2xx HTTP status code. Any other information returned in the response headers or response body is ignored.
If a webhook is not successfully received for any reason, Checkr will continue trying to send it every minute for 10 minutes, then every hour for 24 hours.
Monitor webhook logs in the Logs page, under the Webhook Logs tab.
These account-level webhooks aren't meant to be used for existing partner or OAuth integrations. To update webhook URLs for a partner integration, contact Checkr Customer Success.
Once webhooks are created, subscribe to the updates you wish to receive. For more information on available subscriptions, please see Webhooks in the Checkr API documentation.
Use the Integrations page to view and manage your partner integrations.
Partner integrations you enabled for your account appear on this tab. To disable the integration for your account, click Turn off. Contact your Checkr Customer Success Manager for more information.
Brands allow you to customize candidate messaging by node. Creating a brand and assigning it to a node in your hierarchy will apply that brand’s logo and URL to any emails issued to candidates associated with that node. This branding will also appear on the apply-flow screens for these candidates.
This allows you to provide a candidate experience that more clearly reflects their specific application.
When issuing invitations to candidates from an Account Hierarchy-enabled account, the selected node’s brand will be used both for the email and for the apply flow screens. If the node does not have a brand associated with it, then the account’s hierarchy tree will be traversed upwards until a node with an assigned brand is found. If there are no nodes assigned to a brand, then the top level account fields will be used.
Map brands to your hierarchy’s nodes. Accounts can have multiple brands.
Once created and assigned nodes, brands will automatically be applied to any candidate invitations issuing from your account.
Create a brand
Use the Account settings > Brands tab to create brands for your account.
To create a brand, use the steps below:
- Enter a name.
- Enter the website for the brand.
- Upload a logo, and click Add brand. (Checkr accepts all file types, and suggests a minimum size of 160x160pixels.)
Your brand will be created and added to the Manage brands panel at the bottom of the page.
While name is the only required field for a brand, brands without websites or logos won't appear in your candidate communications.
Assign nodes to brands
Assign nodes to brands to customize candidate communications by nodes in your account.
To assign a node to a brand, use the steps below:
- From the Manage brands list, click Assign nodes.
- Use the window that opens to select nodes for your brand, and click Save.
- Confirm your selection, and the node will be assigned to the brand.
The Account Hierarchy page allows customers with simple account structures (fewer than 150 nodes) to create and manage their account hierarchy.
Hierarchies that include nodes with parent-child relationships won't appear in the dashboard.
Add nodes to your account
Nodes are individual entities within your Checkr account. Nodes can be assigned to packages, PAM, brands, and users inside of the Checkr Dashboard.
Nodes can be used to assign account objects and restrict users. This model can be used to match your company's hierarchy (a node = an office) or more abstractly (a node = a position). Node IDs are defined by the user, so the associations made inside of Checkr (such as assigning a node to a package) are kept even when the hierarchy changes. This provides a highly flexible means of integrating Checkr into your existing hierarchies and operations.
Use nodes to structure your account into multiple individual working units, which represent your business with respect to your hiring and background check needs.
Once defined, nodes may be used to manage the relationship of your packages and other account settings to users and candidates within your account. Once defined, use the Checkr Dashboard to assign nodes to users, packages, your adjudication matrix, and other aspects of your Checkr account.
After you submit a hierarchy, you must maintain at least one node on your account. You can edit a single remaining node in your account hierarchy, but you can't delete it.
To add nodes, use the steps below:
- Click Add Row.
- Enter a name and a custom ID for the node.
- Select a tier (your custom label for this level in your hierarchy).
- Select a parent node. If no parent is selected, the node will be placed at the top level of your hierarchy.
- Click Submit Hierarchy.