HireRight integrations: Processing errors

Persona

Program office users

How to steps

Errors in each section are listed in alphabetical order.

Retrieve package process

These errors occur while the system is retrieving the information needed to create or validate a candidate background check package. They typically indicate missing configuration details, authentication issues, or communication problems between the Enterprise platform and HireRight. Resolving these errors usually involves verifying integration settings and provider credentials.

Access denied

Error message: HireRightErrorCode.Unauthorized

What it means: The request was blocked due to insufficient permissions or invalid credentials.
What to do: Check all authentication credentials (subscription key, login, domain ID) and confirm the account has the required access.

Access denied due to invalid subscription key

Error message: HireRightErrorCode.UnauthorizedInvalidSubscriptionKey

What it means: HireRight rejected the request because the subscription key is invalid.
What to do: Replace the subscription key with a valid one and confirm it has permission to access the requested API.

API not found

Error message: HireRightErrorCode.NotFound

What it means: The requested HireRight API endpoint does not exist or is unavailable.
What to do: Confirm that the API route is correct and supported by the HireRight API version you are using.

Error in deserializing HireRight Response

Error message: HireRightErrorCode.ErrorInDeserializingHireRightResponse

What it means: The system received a response from HireRight but could not interpret the data format.
What to do: Check for API changes or malformed responses and confirm the response structure matches the expected schema.

Error received when calling API route. Route: {0}

Error message: BackgroundCheckProviderErrorCode.ResponseErrorCode

What it means: HireRight returned an error response for the specified API route.
What to do: Review the API route, request payload, and response details to identify and correct the issue.

Generic system error

Error message: HireRightErrorCode.GenericSystemError

What it means: An unexpected system error occurred during processing.
What to do: Retry the request. If the issue persists, gather logs and contact support for further investigation.

HTTP request timed out. URL: {0}

Error message: BackgroundCheckProviderErrorCode.TimeoutException

What it means: The request to HireRight took too long and timed out.
What to do: Check network connectivity and HireRight service availability, then retry the request.

Invalid Subscription Key from the provider data

Error message: HireRightErrorCode.InvalidSubscriptionKey

What it means: The provided subscription key is not recognized by HireRight.
What to do: Verify that the subscription key is correct, active, and associated with the correct HireRight account.

Missing company login from the provider data

Error message: HireRightErrorCode.MissingCompanyLogin

What it means: The HireRight company login credential was not provided in the request.
What to do: Ensure the company login is configured and passed correctly from the provider data settings.

Missing domain ID from the provider data

Error message: HireRightErrorCode.MissingDomainId

What it means: The HireRight domain identifier required to process the request is missing.
What to do: Confirm that the Domain ID is included and correctly mapped in the provider configuration data.

Missing or invalid API URL

Error message: HireRightErrorCode.MissingApiUrl

What it means: The system cannot find a valid HireRight API endpoint to send the request.
What to do: Verify that the HireRight API URL is configured correctly in your integration settings and that it matches the environment you are using (test or production).

Missing subscription key from the provider data

Error message: HireRightErrorCode.MissingSubscriptionKey

What it means: The API subscription key required for authentication is missing.
What to do: Add the correct subscription key to the provider configuration and retry the request.

Create Order Process

These errors happen when the system attempts to create a new background check order in HireRight. They often point to invalid vendor configuration, missing required data, or authorization problems that prevent the order from being successfully submitted. Reviewing provider setup and request data will usually resolve these issues.

Access denied

Error message: HireRightErrorCode.Unauthorized

What it means: The request was blocked due to insufficient permissions or invalid credentials.
What to do: Check all authentication credentials (subscription key, login, domain ID) and confirm the account has the required access.

Access denied due to invalid subscription key

Error message: HireRightErrorCode.UnauthorizedInvalidSubscriptionKey

What it means: HireRight rejected the request because the subscription key is invalid.
What to do: Replace the subscription key with a valid one and confirm it has permission to access the requested API.

API not found

Error message: HireRightErrorCode.NotFound

What it means: The requested HireRight API endpoint does not exist or is unavailable.
What to do: Confirm that the API route is correct and supported by the HireRight API version you are using.

Error in deserializing HireRight Response

Error message: HireRightErrorCode.ErrorInDeserializingHireRightResponse

What it means: The system received a response from HireRight but could not interpret the data format.
What to do: Check for API changes or malformed responses and confirm the response structure matches the expected schema.

Error received when calling API route. Route: {0}

Error message: BackgroundCheckProviderErrorCode.ResponseErrorCode

What it means: HireRight returned an error response for the specified API route.
What to do: Review the API route, request payload, and response details to identify and correct the issue.

Generic system error

Error message: HireRightErrorCode.GenericSystemError

What it means: An unexpected system error occurred during processing.
What to do: Retry the request. If the issue persists, gather logs and contact support for further investigation.

HTTP request timed out. URL: {0}

Error message: BackgroundCheckProviderErrorCode.TimeoutException

What it means: The request to HireRight took too long and timed out.
What to do: Check network connectivity and HireRight service availability, then retry the request.

Invalid Subscription Key from the provider data

Error message: HireRightErrorCode.InvalidSubscriptionKey

What it means: The provided subscription key is not recognized by HireRight.
What to do: Verify that the subscription key is correct, active, and associated with the correct HireRight account.

Missing company login from the provider data

Error message: HireRightErrorCode.MissingCompanyLogin

What it means: The HireRight company login credential was not provided in the request.
What to do: Ensure the company login is configured and passed correctly from the provider data settings.

Missing domain ID from the provider data

Error message: HireRightErrorCode.MissingDomainId

What it means: The HireRight domain identifier required to process the request is missing.
What to do: Confirm that the Domain ID is included and correctly mapped in the provider configuration data.

Missing or invalid API URL

Error message: HireRightErrorCode.MissingApiUrl

What it means: The system cannot find a valid HireRight API endpoint to send the request.
What to do: Verify that the HireRight API URL is configured correctly in your integration settings and that it matches the environment you are using (test or production).

Missing subscription key from the provider data

Error message: HireRightErrorCode.MissingSubscriptionKey

What it means: The API subscription key required for authentication is missing.
What to do: Add the correct subscription key to the provider configuration and retry the request.

Unable to process HireRight background check creation of order: {0}

Error message: HireRightErrorCode.VendorAccountValidationError

What it means: The background check order could not be created due to a vendor account validation issue.
What to do: Verify that the HireRight vendor account is properly configured and enabled for order creation.

Update Process

These errors occur when the system is updating an existing background check order. They indicate missing, mismatched, or invalid reference data, or that the system cannot locate the corresponding HireRight record. Fixing these errors typically requires validating IDs, statuses, and required update fields.

Client Reference Values is required

Error message: HireRightErrorCode.ClientReferenceValuesRequired

What it means: No client reference values were provided for the update request.
What to do: Include valid client reference values to identify the background check record.

Data Field in Reference Id {0} is either Null or Empty!

Error message: BackgroundCheckUpdateProcessErrorCode.DataFieldIsNullEmpty

What it means: A required reference field needed for the update process is missing or blank.
What to do: Populate the missing field in the reference ID and resubmit the update request.

Date Modified is required

Error message: HireRightErrorCode.DateModifiedRequired

What it means: The update request does not include the date the order was last modified.
What to do: Add the Date Modified field to the request payload and resubmit.

No equivalent candidate background check record found in the system

Error message: BackgroundCheckProviderErrorCode.NoCandidateBackgroundCheckRecordFound`

What it means: The system cannot find a matching background check record to update.
What to do: Confirm that the reference IDs match an existing HireRight background check record.

Procurement Resource ID in client reference values does not match in the order's Resource ID

Error message: HireRightErrorCode.ResourceIDDoesNotMatchCandidateResourceID

What it means: The provided Procurement Resource ID does not match the one associated with the order.
What to do: Verify that the correct Procurement Resource ID is being sent for the specified order.

Procurement Resource ID in client reference values is required

Error message: HireRightErrorCode.ResourceIDRequired

What it means: The Procurement Resource ID is missing from the client reference values.
What to do: Add the Procurement Resource ID to the client reference values and retry the update.

Order ID is required

Error message: HireRightErrorCode.OrderIdRequired

What it means: The system cannot identify which order to update because the Order ID is missing.
What to do: Provide a valid Order ID in the update request.

Order Status is required

Error message: HireRightErrorCode.OrderStatusRequired

What it means: The update request is missing the order status.
What to do: Include a valid order status value when submitting the update.

Status Details is required

Error message: HireRightErrorCode.StatusDetailsRequired

What it means: Additional status information required for the update is missing.
What to do: Include the Status Details field with appropriate values before retrying the update.