Skip to main content
Sterling

Sterling integrations: Processing errors

  • July 3, 2025
  • 0 replies
  • 14 views

Product Content Manager
Community Manager

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.

Candidate creation process errors

This topic outlines integration errors that might occur while the data required to create a candidate record is being exchanged between Beeline Enterprise and Sterling. Errors are listed alphabetically. If you encounter an error, contact your Enterprise representative and/or create a support ticket.

Conflict

Enterprise was unable to create a new candidate record in Sterling because the email specified for the candidate already exists in Sterling’s system.

Error message

Duplicate Sterling API Payload candidate email.

Invalid email format

Enterprise was unable to create a new candidate record in Sterling because the composition of the candidate’s email doesn’t match the required format.

Error message

Invalid Sterling API Payload Candidate Email.

Missing client reference ID

Enterprise was unable to create a new candidate record in Sterling because the Client Reference ID is mandatory but is absent in the webhook update payload. The Client Reference ID associates candidates submitted from Enterprise to the correct account in Sterling and synchronizes accurate data updates. In Enterprise, the Client Reference ID is called the Procurement Resource ID or Beeline ID. You can locate that ID on the resource’s profile in Enterprise.

Error message

Missing Sterling API Payload Client Reference ID.

Missing first name

Enterprise was unable to create a new candidate record in Sterling because the given name for the candidate is mandatory but is absent in the update webhook payload.

Error message

Missing Sterling API Payload Candidate First Name.

Missing email

Enterprise was unable to create a new candidate record in Sterling because an email for the candidate is mandatory but is absent in the webhook updated payload.

Error message

Missing Sterling API Payload candidate email.

Missing last name

Enterprise was unable to create a new candidate record in Sterling because the surname for the candidate is mandatory but is absent in the webhook updated payload.

Error message

Missing Sterling API Payload Candidate last name.

Missing required fields

Enterprise was unable to create a new candidate record in Sterling because data is missing from required fields. These fields are required when creating a new resource: First Name, Last Name, and Email.

Error message

Missing Sterling Required Fields: {0}

Candidate screening creation process errors

This topic outlines integration errors that might occur while the data required to initiate a background check order is being exchanged between Beeline Enterprise and Sterling. Errors are listed alphabetically. If you encounter an error, contact your Enterprise representative and/or create a support ticket.

Missing Sterling Background Check Package ID

Enterprise was unable to initiate a background check order in Sterling because the package identification is mandatory but is absent in the update webhook payload.

Error message

SterlingErrorCode.MissingSterlingBackgroundCheckPackageId.

Missing Sterling Candidate ID

Enterprise was unable to initiate a background check order in Sterling because the Sterling identification for the candidate is mandatory but is absent in the update webhook payload.

Error message

Missing request payload Sterling candidate ID property.

Missing required response fields

Enterprise was unable to initiate a background check order in Sterling because specific fields (Order Result, Start Date, and Completion Date) are required but are absent in the webhook response.

Error message

Missing Sterling API Response Data Fields.

Missing web service base route

Enterprise was unable to establish a successful connection to the configured API Base URL. The configured API Base URL was either invalid or doesn’t exist.

Error message

Missing API web service base route configuration.

Missing webhook credential

Enterprise was unable to authenticate into the Sterling API URL due to invalid credentials.

Error message

Missing API webhook credentials configuration.

Order create date required

Enterprise was unable to initiate a background check order in Sterling because the date the background check was initiated is mandatory but is absent in the webhook response payload.

Error message

Screening create date is required.

Order reference URL required

Enterprise was unable to initiate a background check order in Sterling because the order reference URL is mandatory but is absent in the webhook response payload.

Error message

Screening Reference URL is required.

Order result required

Enterprise was unable to initiate a background check order in Sterling because the outcome of the initiated background check is mandatory but is absent in the webhook response payload.

Error message

Screening result is required.

Order status required

Enterprise was unable to initiate a background check order in Sterling because the state of the initiated background check is mandatory but is absent in the webhook response payload.

Error message

Screening Status is required.

Update process errors

This topic outlines integration errors that might occur while updates to the status and results for a background check order are sent from Sterling to your Enterprise platform. Errors are listed alphabetically. If you encounter an error, contact your Beeline representative and/or create a support ticket.

Candidate ID does not match Candidate Resource ID

The Candidate ID associated with the Background Check Order ID in the response payload does not match the Procurement Resource ID stored in Enterprise.

Error message

Candidate Resource ID ({0}) does not match with the Candidate ID Reference Code ({1}) in the Payload Data.

Error in deserializing JSON object

Enterprise was unable to process the response retrieved from Sterling while retrieving a candidate record or a background check order record. The update payload either contains an invalid property or isn’t in the correct JSON format.

Error message

Error In Deserializing JSON Object.

Missing candidate ID

Enterprise was unable to retrieve background check results from Sterling because a candidate ID is mandatory but is absent in the webhook update payload.

Error message

Missing response payload candidate ID.

Missing completion date

Enterprise was unable to retrieve background check results from Sterling because the background check fulfillment date is mandatory but is absent in the webhook update payload.

Error message

Missing response payload completion date.

Missing start date

Enterprise was unable to retrieve background check results from Sterling because the date the background check was initiated is mandatory but is absent in the webhook update payload.

Error message

Missing response payload start date.

No candidate background check record found

The integration was unable to return a background check record for the specified client.

Error message

Unable to retrieve Candidate Provider Background Check Record.

Order result required

Enterprise was unable to retrieve background check results from Sterling because the outcome of the initiated background check is mandatory but is absent in the webhook update payload.

Error message

Screening result is required.

Order status required

Enterprise was unable to retrieve background check results from Sterling because the state of the initiated background check is mandatory but is absent in the webhook update payload.

Error message

Screening Status is required.

Screening ID required

Enterprise was unable to retrieve background check results from Sterling because the screening ID is mandatory but is absent in the webhook update payload.

Error message

Screening ID is required.

 

Supported release: Enterprise Q1 2024

This topic has been closed for replies.