Manage your account

Additional Topics

Analytics >

Articles

  • User permissions >

    Checkr's user roles provide varying levels of access for team members involved in each stage of the background check process.

    Assign roles to users

    For security purposes, Checkr can't edit user permissions. To edit or add user roles for your account, contact your team's admin. By default, the first user on an account is always an admin.

    To manage user permissions, log in to the Checkr Dashboard as an admin. Open the Account settings page. Select the Users tab, and then select Edit in the Roles column.

    Depending on the user's role, set one or more of the permissions below. Individual users can have multiple roles, such as adjudicator and requester. To create custom roles and permissions, contact Checkr.

    Available user roles

    • Billing: Billing users can access only the "Payment & billing" page of the Checkr Dashboard.
    • Limited user: The limited user role can access the candidates list and the report status, result, and assessment. Limited users can't access candidate or report details. New users on an account automatically have this role.
    • Requester: The requester role can perform the tasks below. Assign this role to recruiters who order background checks.
      • Access candidate-provided documents but not completed report details.
      • Access report statuses on the Candidates page but not the results of completed reports.
      • Access, send, monitor, and cancel background check invitations.
      • Add a search to an existing package.
    • Adjudicator: The adjudicator role can perform the tasks below. Assign this role to adjudication staff.
      • Access candidate report details.
      • Adjudicate reports.
      • Engage candidates.
      • Send pre-adverse action notices to candidates.
    • Restricted admin: The restricted admin role can perform all tasks of adjudicators and requesters for candidates in their account node but can't update billing information or settings. This role applies only for accounts that have a hierarchy with at least one node.This role can also perform the tasks below. Assign this role to administrators for subnodes on your account.
      • Add searches.
      • Assign non-admin user roles.
      • Find invoices.
      • Invite users to the account.
    • Admin: The admin role has access to all functionality in the Checkr Dashboard, with no node restrictions. This role can perform all tasks, including the ones below. Limit this role to core members of your team.
      • Add searches.
      • Assign roles to any account user.
      • Save packages.
      • Update account settings, including billing information.

    Individual users can have multiple roles, such as adjudicator and requester. To create custom roles and permissions, contact Checkr.

    Play the Checkr Academy video below to learn how to add and manage users and roles.

    Assign work locations to users

    Use work locations to manage access to candidate information for your team by geographic location. Users subscribed to a specific location can access and manage candidates only in those locations.

    To manage the locations assigned to a specific user, use the steps below:

    1. Select the menu icon at the far right of the user's name.
    2. Select "Edit geos."
    3. Choose the locations to subscribe that user to.
  • FAQs about managing your account >

    To reset your password, use the steps below:
    1. Navigate to the Checkr login page.
    2. Select "Don't remember your password?"
    3. Enter your email address to receive a password-reset email. The link is valid for four hours after it's sent.
    If you don't receive the email, check your junk mail folder. If you received multiple emails, use the most recent one.
    Note

    After ten failed password entries, Checkr locks your account. To unlock your account, ask an admin on your team to help you reset your password.

    Checkr doesn't support merging accounts or moving reports between accounts.
    If your organization has multiple Checkr accounts, contact Checkr to close the additional accounts.

    The URI name is a unique account identifier that you can't change.
  • Manage account users >

    If you have the admin user role, you can do the tasks below in the Users tab of the Account page of the Checkr Dashboard:

    • Add new users.
    • Find, edit, manage, or delete existing users.

    Add new users

    To add a user, enter the person's email address and full name and select "Send invitation." Checkr invites the user to set up a password and log in. 

    Note

    Because Checkr can't add users to your account, we recommend that you create multiple admin users.

    All admin users left your organization

    If all admin users leave your organization, contact Checkr with your organization's EIN or tax ID. Checkr contacts you after creating the admin user account.

    Assign roles to users

    Checkr can't edit user roles. To edit or add user roles for your account, contact your admin. By default, the first user on an account is an admin. Checkr offers user roles with varying permissions.

    To assign roles to your users and grant them permissions within the Checkr Dashboard, select Edit in the Roles column.

    Delete users

    To delete existing users from your account, select the menu icon and select Delete User. Checkr issues a confirmation and then deletes the user from your account. You can't restore deleted users, but you can add the same email address again.

    Unlock user accounts

    Users with too many failed login attempts lose access to their accounts. To regain access to their account, a user must reset their password. To send a user a password-reset email, select "Unlock user" from the menu next to their name.

    Assign nodes to users

    Before you can assign nodes to users, take the steps below for your account:

    1. Create a hierarchy of nodes.
    2. Request that Checkr enable user restrictions by nodes.

    To use nodes to restrict user permissions, use the steps below:

    1. From the menu, select "Assign nodes."
    2. Select nodes to assign to, or unassign from, the user.
    3. Review your selection, and select Yes to confirm.

  • Manage packages >

    Access the Packages page

    Only users with the correct permissions can access the Packages page in the Checkr Dashboard. If you need access to this page, work with your admin.

    Create a custom package

    To create a custom package of searches, use the steps below:

    1. Select the "Create new package" button.
    2. Set the candidate's work location.
    3. Select the package you want. The total appears with fees at the right.
    4. Review available add-ons, and use the Add button to select ones for your package. Below the package summary, you can name the package and save it for later. 

    Add searches to a package

    Checkr offers searches that you can add to existing packages. Some customization options might be unavailable through partner integrations, and some searches might take additional setup time.

    To add searches to an existing package, use the steps below:

    1. Select the pencil icon on the package you want to edit.
    2. Select Add on the search you want to add. If you want to save this package for later use, name it.
    3. Select Save.

    You can also add searches using the "Order background check" button on the Checkr Dashboard:

    1. Select "Order background check."
    2. Set the candidate's location.
    3. Proceed based on which invitation method you prefer:
      • Up to 200 candidates: Enter the candidates' email addresses, and select Continue.
      • Up to 5,000 candidates: Select Upload CSV, attach the file, and select Upload.
    4. Select a package and optional additional searches.
    5. Review and then submit your order.

    You can't remove searches from a base package. Instead, create a custom package.

    Unavailable county or state records

    If records are unavailable for a state or county search in a package, contact Checkr to enable your account to skip those searches. You decide whether to reorder full or partial searches when records are available.

    Assign nodes to a package

    If your account has nodes, you can assign them to packages. Child nodes inherit packages from their parents in addition to packages you add directly to them.

    To assign new nodes to or remove nodes from a selected package, use the steps below:

    1. Select a package, and then select "Assign nodes."
    2. Use the Search Node List field to search for nodes in your hierarchy. You can search by name or by custom ID. To show only nodes currently assigned to the package, select the "Show only selected nodes" checkbox.
    3. Select the nodes you want to assign to or remove from the package. 
    4. Select Yes to confirm and save your changes.

    Delete a package

    If you no longer need a package, you can delete it using the steps below:

    1. Select the Actions column of the package you want to delete.
    2. Select Delete, and then confirm that you want to delete the package.
  • Set account notifications >

    Use the Notifications tab to select the content and frequency of automated email notifications you receive. 

    Each user can set their own email notification preferences. In the Checkr Dashboard, select Account and then select the Notifications tab.

    Checkr can send emails about the topics below:

    • All report updates: Receive an email for all changes to report status.
    • All candidate updates: Receive an email when you send an invitation or an invitation expires.
    • All candidate stories: Receive an email for every candidate story submission.

    You can get notifications about more specific report and candidate events. For example, you can receive email notifications about specific report status changes. 

    Play the Checkr Academy video below to learn how to set notifications sent to you in the Checkr Dashboard.

    Learn from Checkr experts

    Go to our learning hub, Checkr Academy, to access video tutorials of Checkr experts showing you how to get started with the Checkr Dashboard.

  • Disable candidate notifications >

    Notifications are critical in ensuring that candidates can provide information and complete their background checks promptly. 

    By default, Checkr sends candidates both email and SMS notifications about the events below:

    • You're requesting a background check about the candidate.
    • The candidate needs to provide information for their background check.
    • The background check is in progress or complete.

    Play the Checkr Academy video below to learn how to set notifications sent to candidates in the Checkr Dashboard.

    Disable candidate SMS notifications

    Use the steps below to disable candidate SMS notifications in the Checkr Dashboard:

    1. Open the Account page.
    2. In the "SMS notifications" section, disable the notifications.

    Disable candidate emails

    To stop sending emails to candidates, contact Checkr. 

  • Review CSV files you uploaded >

    Background check orders

    To review the background checks you ordered using a CSV file upload, use the steps below:

    1. In the Checkr Dashboard, select "Payment & billing."
    2. Select the Documents tab.
    3. Select a CSV file to download. The file includes errors that happened during the order process.

    To review orders for candidates whose email addresses you entered manually, use the Candidates page instead.

    Continuous searches

    To review CSV files for continuous searches, use the steps in Manage continuous searches.

  • Self-Service SSO: Enable Single Sign On using SAML for your account >

    You can establish SAML connections with your preferred identity provider (IdP) and use Checkr as a service provider (SP).

    Checkr supports the standard SCIM APIs. To provision SCIM API for your account, contact Checkr.

    Prerequisites

    Checkr SSO has requirements for SAML connections, and more specific requirements for IdP-initiated and SP-initiated connections. Before initiating the connection, review your Checkr account and IdP setup to confirm that your setup is compatible with Checkr SSO.

    For all SAML connections

    • Checkr doesn't provide and can't interpret SAML metadata.
    • Checkr uses HTTPS at the transport layer to secure network traffic you send to us. Checkr doesn't support additional assertion encryption.

    For IdP-initiated connections

    • If you have multiple Checkr accounts, each account requires a separate SAML connection.
    • If you choose only IdP-initiated connections, Checkr can't prevent your users from changing their passwords on the Checkr platform. If you use SP-initiated connections with an email domain, Checkr can enforce these rules.
    • Your Checkr account allows users to have different email address domains.

    For SP-initiated connections

    • If your organization has multiple Checkr accounts, you must first confirm that each of your email domains is attached to only one Checkr account. For example, users with an @bobsplumbingservice.com email address can be associated with only one of your Checkr accounts. Your users must log in to separate Checkr accounts with separate email addresses.
      • Checkr accounts allow multiple unique email domains to be associated with that account’s SSO connection Each unique domain can be associated with only one Checkr account.
      • Checkr identifies users by their email address, which must be unique. Each Checkr user can belong to only one Checkr account at a time.
    • Users must first authenticate through your IdP before they can access the Checkr Dashboard. Setting up SP-initiated SSO diables direct login to your account.

    Select your identity provider to learn how to enable SSO for Checkr.

    Configure IdP-initiated SSO

    1. In the Microsoft Azure Active Directory tenant nav tray, select Enterprise Applications. blobid0.png
    2. Select New Application.
    3. Select "Create your own application."
    4. On the right side of the screen, use the steps below:
      • Name your application.
      • Confirm that "Non-gallery" is selected.
      • Select Create.blobid1.png
    5. Select "Assign users and groups" and then "Add user/group" to add users or groups. Users you add must have a consistent attribute in Azure AD that matches their Checkr login email. The most common choices are usually user.mail or user.userprincipalname.
    6. On your application’s Overview page, select "Get started" in the "2. Set up single sign on" section.
    7. Select SAML.
    8. Use the information from the Single Sign On page in the Checkr Dashboard to update the information below in Azure:
      • Basic SAML Configuration section in Azure
        • Use the Single Sign On URL field in the Checkr Dashboard to update the Reply URL (Assertion Consumer Service URL) in Azure.
        • Use the Audience field in the Checkr Dashboard to update the Identifier (Entity ID) field in Azure.
      • Attributes & Claims section in Azure
        • As the attribute, enter "email" and use all lowercase.
        • Enter the user field your organization uses to store the email addresses for use as Checkr logins.blobid2.png
    9. In Azure, the "SAML Certificates" section populates.
    10. In Azure, select the Download link next to Certificate (Base64). In the Checkr Dashboard, select Choose File in the Signing Certificate section to upload the file you downloaded from Azure. The image below shows a Remove Current Cert button where the Choose File button will be. blobid3.png
    11. Use the Login URL field in Azure to update the Sign In URL field in Checkr.
    12. In the Checkr Dashboard, select Save.
    13. Log out of the Checkr Dashboard.
    14. Log out of Azure.

    Test your configuration

    To test your configuration, use the steps below in Azure:

    1. Confirm that you assigned your current user to the application.
    2. Confirm that your current user has a Checkr user name in the field assigned to the email attribute.
    3. Select the Test button.

    Configure SP-initiated SSO

    1. Complete the steps for IdP-initiated SSO above.
    2. In the Checkr Dashboard, navigate to Account settings > Single Sign On.
    3. In the Email Domain field, enter an email domain. Only user names with this domain can log in.blobid4.png
    4. Select Save.

    Test your configuration

    Ask a user on your Checkr account to complete the steps below:

    1. Log out of the Checkr Dashboard.
    2. Open the Checkr login screen.
    3. Enter a user name that has your configured email domain. The password field should disappear. The screen should redirect to your IdP for authentication and then back to Checkr and log in.

    If the test fails, complete the steps below and then repeat the test:

    1. Return to your Azure application’s SSO configuration.
    2. In the "Sign on URL" field, add dashboard.checkr.com/login.
    3. Select Save.
    4. Download the certificate again.
    5. In the Checkr Dashboard, upload the new certificate and save.

    Configure IdP-initiated SSO

    Sign in to a Google Workspace account that has super admin permissions, and use the steps below:

    1. Select Home, and then select Apps.
      GWimage8.png
    2. Select "Web and mobile apps."
      GWimage4.png
    3. Select "Add custom SAML app."
      GWimage3.png
    4. Enter the app name and an optional description and icon.
      GWimage5.png
    5. Select Continue.
    6. In the Checkr Dashboard, select Account settings > Single Sign On.
    7. Use the information from the "Configure SSO for SAML" page in Google Workspace to update the Single Sign On page in the Checkr Dashboard:
      1. Use the SSO URL field in Google Workspace to update the Sign In URL field in the Checkr Dashboard.
      2. In Google Workspace, select the download icon next to the certificate. 
      3. In the Checkr Dashboard, select Choose File in the Signing Certificate section to upload the file you downloaded from Google Workspace.
      4. In Google Workspace, select Continue.
        GWimage2.png
    8. Use the information from the Single Sign On page in the Checkr Dashboard to update the Service Provider Details page in Google Workspace.
      1. Use the Single Sign On URL field in the Checkr Dashboard to update the ACS URL field in Google Workspace.
      2. Use the Audience field in the Checkr Dashboard to update the Entity ID field in Google Workspace.
      3. In Google Workspace, set the name ID format to "email."
      4. In Google Workspace, select Continue.GWimage1.png
    9. In the "Attribute mapping" page of Google Workspace, select "Add another mapping."
      GWimage7.png

    10. Below "Google Directory attributes,", enter "Primary email."

    11. Below "App attributes,", enter "email."

    12. Select Add Mapping.
      GWimage9.png

    13. In Google Workspace, select Finish.

    Test your configuration

    To test your configuration, use the steps below in Google Workspace:

    1. Open the Admin console.
    2. Select Home, and then select Apps.
    3. Select "Web and mobile apps."
    4. Select your custom SAML app.
    5. At the top left, select "Test SAML login." Your app should open in a separate tab.

    Configure SP-initiated SSO

    1. Complete the steps for IdP-initiated SSO above.
    2. In the Checkr Dashboard, select "Account settings" > Single Sign On.
    3. In the Email Domain field, enter an email domain. Only user names with this domain can log in.
    4. Select Save.

    Test your configuration

    Ask a user on your Checkr account to complete the steps below:

    1. Log out of the Checkr Dashboard.
    2. Open the Checkr login screen. 
    3. Enter a user name that has your configured email domain. The password field should disappear. The screen should redirect to your IdP for authentication and then back to Checkr and log in.

    If the test fails, complete the steps below and then repeat the test:

      1. Return to your Google Workspace application’s SSO configuration.
      2. In the "Sign on URL" field, add dashboard.checkr.com/login. 
      3. Select Save. 
      4. Download the certificate again.
      5. In the Checkr Dashboard, upload the new certificate and save.

    Configure IdP-initiated SSO 

      1. In Okta, select the Applications tab and select Create App Integration.blobid5.png
      2. Select SAML 2.0 as the login method.
      3. In General Settings, configure basic visibility settings for your app in Okta. When you finish, select Next.
      4. In a new browser tab, log in to the Checkr Dashboard as an admin user and select Account settings > Single Sign On.
      5. Use the information from the Checkr Dashboard to update the fields below in Okta:
        • Single sign on URL
        • Audience URI (SP Entity ID)

          blobid6.png
      6. In Okta, select options for the items below and then select Next:
          • Name ID format
          • Application username
          • Attribute Statements (optional)
      7. In Okta, answer questions on the Feedback page, and select Finish. The "How to Configure SAML 2.0 for {appname} Application" page should open. If the page doesn't open, select "View SAML setup instructions."
      8. Use the information from Okta to update the Sign In URL field in the Checkr Dashboard.blobid7.png
      9. In Okta, select "Download certificate."
      10. In the Checkr Dashboard, select Choose File in the Signing Certificate section to upload the file you downloaded from Okta.
      11. In the Checkr Dashboard, select Create.

    Test your configuration

    Ask a user on your Checkr account to complete the steps below:

    1. Log out of the Checkr Dashboard.
    2. Log in to Okta and select the Checkr tile.

    If the user can't log in, confirm that "email" is all lowercase in the Name field of the Email Attributes section. If you make changes to your configuration, use the steps below:

    1. In Okta, select "Download certificate."
    2. In the Checkr Dashboard, select Choose File in the Signing Certificate section to upload the file you downloaded from Okta.
    3. In the Checkr Dashboard, select Create.

    Configure SP-initiated SSO

    1. Complete the steps for IdP-initiated SSO above.
    2. In the Checkr Dashboard, select Account settings > Single Sign On.
    3. In the Email Domain field, enter an email domain. Only user names with this domain can log in.blobid8.png
    4. Select Save.

    Test your configuration

    Ask a user on your Checkr account to complete the steps below:

    1. Log out of the Checkr Dashboard.
    2. Open the Checkr login screen.
    3. Navigate to dashboard.checkr.com, and enter a user email with your configured email domain. The password field should disappear. The screen should redirect to your IdP for authentication and then back to Checkr and log in.
  • Feature comparison: Checkr Dashboard, APIs, and partner integrations >

    Checkr provides multiple ways to order background checks for your candidates:

    These options serve different customers and different uses. For most new customers, Checkr recommends using the Checkr Dashboard. Some customers prefer a customized implementation built on our API or a Checkr partner integration with their applicant tracking system (ATS).

    Checkr Dashboard

    The Checkr Dashboard provides easy entry to the platform's functionality. Workflows help you perform the actions below:

    • Analyze your team's productivity.
    • Initiate adverse action.
    • Manage your candidate pool.
    • Order reports.

    Using the Checkr Dashboard provides the benefits below:

    • Seamless sign-up process
    • No configuration or development work
    • Multiple pre-configured background check packages available
    • Checkr-managed candidate sign-up
    • Multiple pre-configured background check packages
    • Checkr-hosted candidate signup that complies with federal and state laws
    • Open invitation links for each background check package
    • Estimated report completion time
    • Customizable motor vehicle record rules
    • Option to manually order background checks
    • Integrated analytics

    If you're interested in using the Checkr Dashboard, contact Checkr.

    Checkr API

    Use Checkr's API to integrate Checkr features directly into your applications. You can use our API to perform the actions below:

    • Create and update candidate profiles.
    • Order reports.
    • Review report and search results.
    • Use webhooks to receive notifications about the background check process.

    Checkr API also supports advanced capabilities such as adverse action, identity verification, and estimated report completion times. If you subscribe to API updates, you receive a notice when the estimated completion time changes. 

    To learn more about Checkr API, refer to the Checkr API documentation. To develop custom integrations using our API, contact Checkr.

    Join us live!

    To learn how to build a custom API integration with Checkr, register for this live training webinar in our learning hub, Checkr Academy.

    Reports API

    Checkr’s Reports API lets you create candidates and reports without linking to a third-party site. Using the Reports API helps you manage your branding and user experience.

    The Reports API includes the benefits below:

    • Status updates to an internal system (webhooks)
    • Automatically send invitations
    • High volume of background checks with an integrated candidate experience
    Note

    The Checkr Reports API can't create credit reports, drug or alcohol tests, or international background check reports. You must order these items through the dashboard or the Invitation API.

    Invitation API

    Checkr’s Invitation API lets you create candidates and send invitations automatically. This integration balances the simplicity of the Checkr Dashboard and the customization options of a Reports API integration. The Invitation API requires less development work and maintenance than the Reports API while providing the benefit of the Checkr Dashboard and Checkr-hosted sign-up.

    Checkr partner integrations

    Checkr partner integration lets you use a single platform for multiple services. When you use Checkr through a partner integration, you receive the benefits below:

    • Fixed costs for background checks
    • Seamless three-step signup process to connect your partner and Checkr accounts
    • System and workflow integration between your background check process and your existing system

    To find out whether we integrate with a system you use, refer to our current partner integrations. If one of these partner integrations is right for your company, contact Checkr.

  • Manage API keys and webhooks >

    The "Developer settings" tab of the account settings in the Checkr Dashboard 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:

    1. In the "New webhook" section of the Account 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>`
    2. Select the Live environment.
    3. Select a jurisdiction: US or CA.
    4. Select the "Include related object in payload" checkbox if you want to.
    5. 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.

     

  • FAQs about Checkr's API >

    Related article: Manage API keys and webhooks

    Select a question below to learn more.

    To receive live API keys, you must complete the API Development Kickoff module. In this module, the API Onboarding team will guide you through the necessary steps to gain production authorization for your API integration.

    Request a Checkr staging account via the following link: Development Environment Request.

    In your Checkr Staging Dashboard, select the ‘Logs’ tab. Here, you can view all API/webhook calls that have been made. If you click on an individual call, it will show you detailed information regarding the payload.

    You can continue to use your Checkr staging account after your API integration goes live in production. If you need to test new features or enhancements, you can continue testing with your Checkr staging account.

    For specific field requirements, refer to the Checkr API Integration Guidance document. Please note that the field requirements will differ for API customers using the Checkr Hosted Flow compared to the Client Hosted Flow.

    We require all our API customers using the Checkr Hosted Flow to include the work location on both candidate and invitation API calls. We want to ensure that all of our customers are set up to order international checks in the future. Although passing the work location in the candidate object is not strictly required architecturally, we do require it for authorization purposes.

  • Manage nodes and brands >

    Nodes are customizable segments that help you manage your Checkr account. After you define nodes, you can assign them to users, packages, 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.

    For example, you can create a node for a location. When you select the node, only packages for that location are available to order. Nodes can help ensure that the right background check gets ordered for the right location or job. 

    You can use brands to customize candidate messaging by node. If you're an admin user, you manage nodes and brands from the Account page of the Checkr Dashboard.

    Manage nodes individually

    Add a node or parent node

    To add a node or parent node, use the steps below:

    1. Below the list of nodes on the "Account hierarchy" tab, select "Add node."
    2. Enter a name and a custom ID for the node.
    3. 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.
    4. Select Submit Hierarchy.

    Add a node tier

    To add a node tier, use the steps below:

    1. Below the list of nodes on the "Account hierarchy" tab, select "Add node."
    2. Enter a name and a custom ID for the node tier.
    3. In the third column, open the menu and enter the node name.
    4. In the fourth column, select a parent node.
    5. Select Submit Hierarchy.

    Remove a node

    To remove a node, select the trash can next to it.

    Manage many nodes

    Upload many nodes

    Uploading nodes creates a new account hierarchy and is possible only when your account has zero nodes or one node.

    1. On the Account page of your Checkr Dashboard, select the "Account hierarchy" tab.
    2. Select "Upload nodes," which is available only when your account has zero nodes or one node.
    3. Select "Download template."
    4. Open the CSV file and update it with information about your account hierarchy in the columns below. Ensure that your CSV file is smaller than 10MB.
      • Name: Name the node in the hierarchy.
      • Custom ID: Create a unique identifier for the node using letters, numbers, spaces, and the optional characters below:
        • Ampersand
        • Colon
        • Hyphen
        • Underscore
      • Parent Custom ID: Include the custom ID of an existing node you want to be the parent node in the hierarchy.
      • Tier: Name the group of nodes in the hierarchy. Options include department names or geographic locations.
    5. In the Checkr Dashboard, select Upload and find the CSV file you updated.
    6. Select Submit. If your CSV file has errors, the dashboard shows what to correct before uploading again.
    7. Your account updates based on how many nodes you uploaded:
      • 300 nodes or fewer:/strong The Account page reloads showing your account's nodes.
      • More than 300 nodes: You receive an email when your hierarchy updates.

    Download your account hierarchy

    To download your account hierarchy as a CSV file, use the steps below:

    1. On the Account page of your Checkr Dashboard, select the "Account hierarchy" tab.
    2. Select "Download nodes," and select where to download the file.
    3. Select Save.

    Manage brands

    The Brands tab appears in the Dashboard 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:

    1. Enter a name.
    2. Enter the website for the brand.
    3. Upload a logo, and select "Add brand." Checkr accepts all image file types, and suggests a minimum size of 160x160 pixels.
    4. Your brand appears in the "Manage brands" section.

    Play the Checkr Academy video below to learn how to upload your organization's logo in the Checkr Dashboard.

    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:

    1. From the "Manage brands" list, select "Assign nodes."
    2. Select nodes for your brand, and select Save.
    3. Confirm your selection.
  • Logs >

    The Logs page provides a log of all your API and webhook calls. Select an individual call or log to find its details and troubleshoot your integration.

    You can use logs during your development cycle to review all API and webhook calls for both successful and unsuccessful requests over time. Logs can help you identify which calls dropped and why.

    API logs

    To search for a specific API call, enter a resource ID for the call. This ID could be the unique `id` for the candidate or the report used in the call. In the search results, select the call to show details. You can also filter the API calls by status and timeframe.

    API logs have the sections below:

    • Summary (timestamp, IP address, API URL called, method used, status of the call, content type, and user agent)
    • Request query parameters
    • Raw request body
    • Parsed request body
    • Response body

    Webhook logs

    This page shows all webhook logs originating from your account's API key or OAuth application.

    To search for a specific webhook event, enter a report ID for the event. In the search results, select the event to show details. You can also filter the webhooks by HTTP response status, timeframe, and retries.

    Webhook logs have the sections below:

    • Summary (timestamp, webhook URL, status, event, and retry number, if applicable)
    • Raw request body
    • Response body