HireRight API Provider Setup

In order to create a connection to HireRight the following steps are required:

  1. Retrieve your HireRight Username, Password, Account ID, Company Login and User Ref ID
  2. Call the POST /instances API to instantiate your HireRight connected app

The HireRight element is a collection of resources providing a pre-built integration into a service endpoint. RESTful methods (POST, GET, PUT, PATCH, DELETE) are used to interact with these resources (accounts, contacts, files) regardless of the type of APIs (SOAP or REST) provided by the endpoint. Elements leverage Cloud Elements API Manager platform services including authentication, data transformation, and event management. The API is built to allow you to create a functional application or integration quickly and easily.

All API calls to Cloud Elements should be made to the https://api.cloud-elements.com/elements/api-v2 base domain. Requests are authorized with an Organization and User secret, as well as an element token. We use many standard HTTP features, like HTTP verbs, which can be understood by many HTTP clients. JSON will be returned in all responses from the API, including errors. The APIs are designed to have predictable, straightforward URLs and to use HTTP response codes to indicate API errors.