Skip to main content
Sterling

Sterling integrations: Adding a Sterling account in Enterprise

  • February 23, 2024
  • 0 replies
  • 29 views

Product Content Manager
Community Manager

Prerequisites

Before you set up a Sterling account in Enterprise, make sure you obtain the following authentication credentials for the client’s or supplier’s Sterling account. Sterling will provide this information to the client or the program office.

  • Provider’s API URL/Provider’s Base Location URL.
  • Client’s username; the client’s Sterling username.
  • Client’s account ID; a unique value is used to associate suppliers with a client’s organization.
  • Client’s or supplier’s secret key; the client’s or supplier’s Sterling password.

You need that information to permit data exchange between the Enterprise platform and Sterling using Enterprise’s application programming interface (API) calls.


As a program office user with the appropriate permissions, you must configure Sterling account information in Enterprise for each supplier in your organization. You can configure or import Sterling account details.  For instructions on importing, go to Importing integration data.

Setting up Sterling accounts in Enterprise lets you:

  • Ensure background checks are processed promptly.
  • Link a supplier’s account to a specific client.
  • Associate a supplier’s account with specific industries.
  • Streamline your onboarding process.

Persona

Program office users

How to steps

Information in this article reflects a standard Enterprise configuration. Your Enterprise platform is based on your organization’s configuration. Settings and/or data visibility rules may vary slightly from what is described.

If you’re setting up a client-initiated model, use the same client Sterling credentials for each supplier Sterling account you add to Enterprise. If you’re setting up a supplier-initiated model, use separate credentials for each supplier account you add to Enterprise. You can set up and manage supplier account credentials only for organizations and industries you have access to.

To add a Sterling account, complete these steps from your Enterprise dashboard.

  1. Select Preferences > VMS Settings > Contingent Staffing. A Contingent Staffing page displays.
  2. Select Background Check Provider Settings. A Background Check Provider page displays showing any background check providers already configured in your Enterprise platform.
  3. Select Add New. An Add Background Check Provider Settings page displays. Use the fields in the Add Background Check Provider Settings section at the top of the page to associate a client with a provider.
  4. In the Name field in the Add Background Check Provider Settings section, enter a label for the provider’s account.
    Best Practice recommendation. Use the provider name followed by a hyphen followed by the supplier name. For example, Sterling‑TopNotchSupplier.
  5. (Optional) In the Description field, add an explanation about the provider’s account. For example, your organization might use this field to identify which location or industry uses a specific integration.
  6. In the Code field, add an acronym for the provider. You can enter up to 255 characters and camelCase is supported. This code is used to identify background check packages when data is imported.
    Best Practice recommendation. Use the provider name followed by the supplier name. For example, SterlingTopNotchSupplier.
  7. Select the Is Active checkbox to make the account available in Enterprise.
  8. From the Background Check Provider list in the Provider Settings section, select Sterling as the background check provider you want to associate with the account.
  9. In the Provider Base Location URL field in the Provider Settings section, add the Sterling application programming interface (API) URL. This URL allows API exchanges between Enterprise and Sterling.
  1. In the Supplier Organization field in the Account Setup section, enter the name of the Supplier organization. For example, Sterling-TopNotchSupplier1.
  2. Follow one of these options:
  • If you’re setting up a client-initiated model, take actions:
  1. In the Client Username field in the Account Setup section, enter the client’s username supplied by Sterling.
  2. In the Account ID field in the Account Setup section, enter the supplier’s identifier supplied Sterling.
  3. In the Secret Key field in the Account Setup section, enter the client’s password supplied by Sterling.

OR

  • If you’re setting up a supplier-initiated model, take actions:
  1. In the Client Username field in the Account Setup section, enter the supplier’s username supplied by Sterling.
  2. Leave the Account ID field in the Account Setup section empty.
  3. In the Secret Key field in the Account Setup section, enter the supplier’s password supplied by Sterling.
  4. From the Available Industries list in the Associated Industries section, select the industries configured for the supplier you want to include in the Sterling integration. Use the Arrow icons to move the industries from Available to Selected.
  1. Select OK. A message displays indicating your changes were saved, and the supplier’s Sterling background check account is activated in Enterprise.
  2. Repeat steps 1 through 12 for each supplier Sterling account you need to add.

You’re done setting up Sterling accounts in Enterprise.

 

Documentation release: Beeline Enterprise | Q1 2024

This topic has been closed for replies.