HireRight

App · 16 actions

Read background-check and I-9 details, search recent orders, and watch individual statuses.

Actions

ActionWhat it does
Get Adjudication StatusesReturns all available adjudication statuses for a given order base on an order id.
Get Company AccountsReturns a list of company accounts.
Get DHS DocumentsRetrieves Drug & Health Screening (DHS) related documents attached to a given Order Id.
Get I-9 Employee Web LinkRetrieves a Single Sign-On (SSO) weblink that will redirect the employee to the Section 1 Worksheet.
Get I-9 Employer Web LinkRetrieves a Single Sign-On (SSO) weblink that will redirect the employer to either the Section 2 Worksheet or the Completed I-9 form, depending on the I-9 Form’s status with HireRight.
Get I-9 FormReturns a base64 encoded pdf file of the I-9 form.
Get I-9 StatusReturns a status summary for an I-9 Form with the specified Form ID.
Get I-9 Supporting DocumentationReturns all I-9 Supporting Documentation attached to a give I-9 Order Id.
Get I-9 Web LinkRetrieves a Single Sign-On (SSO) weblink that will redirect the employer to I-9 Form PDF.
Get Order FormReturns the order form (Applicant Data) submitted for a specific Order ID.
Get Order ReportReturns the report for the order with a specific Order ID.
Get Order StatusReturns a status summary for the order with the specified Order ID.
Get Order Supporting DocumentationRetrieves Supporting Documents a ttached to a specific Order Id.
Get PackagesReturns the list of available packages for the current user.
Get ProductsReturns the list of available products for the current user.
Search ordersFind orders created within a window of at most 24 hours.

Get Adjudication Statuses

Returns all available adjudication statuses for a given order base on an order id.

Inputs

Order idorder_idtextRequired
The id used to identify the order.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "currentlyEnabledStatuses": []
  },
  "has_more": false,
  "next_cursor": null
}

Get Company Accounts

Returns a list of company accounts.

Inputs

None.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "accounts": []
  },
  "has_more": false,
  "next_cursor": null
}

Get DHS Documents

Retrieves Drug & Health Screening (DHS) related documents attached to a given Order Id.

Inputs

Order idorder_idtextRequired
The id used to identify which order to retrieve DHS documents for.
Typetypetext
Document type.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "documents": [],
    "id": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Retrieves a Single Sign-On (SSO) weblink that will redirect the employee to the Section 1 Worksheet.

Inputs

Form idform_idtextRequired
The id used to identify which I-9 form to generate employee link for.
EmailemailtextRequired
Employee email address.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "href": "example",
    "status": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Retrieves a Single Sign-On (SSO) weblink that will redirect the employer to either the Section 2 Worksheet or the Completed I-9 form, depending on the I-9 Form’s status with HireRight.

Inputs

Form idform_idtextRequired
The id used to identify which I-9 form to generate employer link for.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "href": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get I-9 Form

Returns a base64 encoded pdf file of the I-9 form.

Inputs

Form idform_idtextRequired
The id used to identify which I-9 form document to retrieve.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "content": "example",
    "contentType": "example",
    "fileName": "example",
    "fileSize": "example",
    "title": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get I-9 Status

Returns a status summary for an I-9 Form with the specified Form ID.

Inputs

Form idform_idtextRequired
The id used to identify which I-9 form to retrieve the status for.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "clientReferenceValues": [],
    "companyLogin": "example",
    "companyName": "example",
    "i9Status": {
      "formCompletionDate": "example",
      "formReverificationDate": "example",
      "reverificationDeadline": "example",
      "status": "example",
      "verificationDate": "example",
      "verificationStatus": "example"
    },
    "id": "example",
    "legalText": {
      "text": "example",
      "type": "example"
    },
    "orderStatus": {
      "dateCompleted": "example",
      "dateInitiated": "example",
      "dateModified": "example",
      "dateReceived": "example",
      "status": "example",
      "timestamp": "example"
    },
    "refId": "example",
    "supportingDocuments": [],
    "userGroupName": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get I-9 Supporting Documentation

Returns all I-9 Supporting Documentation attached to a give I-9 Order Id.

Inputs

Form idform_idtextRequired
The id used to identify which I-9 form to retrieve the supporting documentation for.
Formatformattext
Response format: BASE64, URL or ZIP.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "disclaimer": "example",
    "documents": [],
    "id": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Retrieves a Single Sign-On (SSO) weblink that will redirect the employer to I-9 Form PDF.

Inputs

Form idform_idtextRequired
The id used to identify which I-9 form to generate link for.
Formatformattext
Web link format: PDF or HTML.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "href": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get Order Form

Returns the order form (Applicant Data) submitted for a specific Order ID.

Inputs

Order idorder_idtextRequired
The id used to identify which order to retrieve the form for.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "backgroundCheck": {
      "backgroundSearchPackage": {
        "personalData": {
          "contactMethods": [],
          "demographicDetail": {
            "dateOfBirth": "example",
            "genderCode": "example",
            "governmentId": {
              "countryCode": "example",
              "value": "example"
            }
          },
          "personName": {
            "familyName": "example",
            "givenName": "example",
            "middleName": "example"
          },
          "postalAddress": {
            "countryCode": "example",
            "deliveryAddresses": [],
            "municipality": "example",
            "postalCode": "example",
            "region": "example"
          }
        },
        "productData": {
          "certifications": [],
          "educationHistory": [],
          "employmentHistory": [],
          "fmcsaPsp": [],
          "military": [],
          "mvrInformation": [],
          "priorPersonalData": {
            "aliases": [],
            "postalAddresses": []
          },
          "references": []
        }
      }
    },
    "disclaimer": "example",
    "flexFields": [],
    "selfReportedConvictions": {
      "convictions": [],
      "wasConvicted": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get Order Report

Returns the report for the order with a specific Order ID.

Inputs

Order idorder_idtextRequired
The id used to identify which order to retrieve the report for.
Formatformattext
Report Format: JSON or PDF.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "commentSources": [],
    "companyLogin": "example",
    "companyName": "example",
    "id": "example",
    "initiatedBy": "example",
    "jobLocation": {
      "countryCode": "example",
      "municipality": "example",
      "postalCode": "example",
      "ref": "example",
      "region": "example",
      "regionCode": "example",
      "useCurrentResidence": false
    },
    "pdfReport": {
      "dateAdjudicated": "example",
      "dateOrderCompleted": "example",
      "dateOrderReceived": "example",
      "fileBytes": "example",
      "fileSize": "example"
    },
    "refId": "example",
    "reports": [],
    "stageOrder": {
      "orderingPath": "example",
      "stages": []
    },
    "status": "example",
    "timeZone": "example",
    "userGroupName": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get Order Status

Returns a status summary for the order with the specified Order ID.

Inputs

Order idorder_idtextRequired
The id used to identify which order to retrieve the status for.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "clientReferenceValues": [],
    "companyLogin": "example",
    "companyName": "example",
    "consumerDispute": {
      "status": "example"
    },
    "id": "example",
    "items": [],
    "legalText": {
      "text": "example",
      "type": "example"
    },
    "orderStatus": {
      "adjudication": "example",
      "adjudicationReason": "example",
      "currentStageStatus": "example",
      "dateAdjudicated": "example",
      "dateCompleted": "example",
      "dateInitiated": "example",
      "dateModified": "example",
      "dateReceived": "example",
      "discrepancyCount": 0,
      "estimatedTAT": {
        "lowerBound": "example",
        "upperBound": "example"
      },
      "itemCount": 0,
      "percentComplete": "example",
      "resultStatus": "example",
      "status": "example",
      "statusDetails": "example",
      "timestamp": "example"
    },
    "package": {
      "id": "example",
      "name": "example"
    },
    "refId": "example",
    "stageOrder": {
      "orderingPath": "example",
      "stages": []
    },
    "supportingDocuments": [],
    "timeZone": "example",
    "userGroupName": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get Order Supporting Documentation

Retrieves Supporting Documents a ttached to a specific Order Id.

Inputs

Order idorder_idtextRequired
The id used to identify which order to retrieve the supporting documentation for.
Formatformattext
Response format: BASE64, URL or ZIP.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "disclaimer": "example",
    "documents": [],
    "id": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get Packages

Returns the list of available packages for the current user.

Inputs

None.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "packages": []
  },
  "has_more": false,
  "next_cursor": null
}

Get Products

Returns the list of available products for the current user.

Inputs

None.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "products": []
  },
  "has_more": false,
  "next_cursor": null
}

Search orders

Find orders created within a window of at most 24 hours. Use at most four times a day, at least six hours apart. Use order status for ongoing monitoring.

Inputs

Created fromcreated_fromdate and timeRequired
Created from to use.
Created tocreated_todate and timeRequired
Created to to use.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "note": {
      "type": "example",
      "value": "example"
    },
    "order": []
  },
  "has_more": false,
  "next_cursor": null
}

On this page