API
Sales

Screening Invite Method

Overview

Invite is an option that Sterling Talent Solutions provides to bridge the API to the underlying platforms. Using invite allows you to specify a method that a candidate can take to finish the screening process. Sterling's platforms will manage the candidate experience once the invite is accepted. This includes the collection of consent and disclosure electronically (if enabled), as well as the collection of any extra necessary information that is pertinent to the screening.

Screening Format

A POST to /screenings must include the object for invite.

{
  "id": "5787",
  "packageId": "64731",
  "candidateId": "864109",
  "callback": {
    "uri": "https://my-company.com/screenings-callback"
  },
  "invite": {
    "method": "link" | "email"
  }
}

The two supported options for method are link and email.

📘

The link option will generate a tokenized link that will invite the candidate to create an account and log in to Screening Direct to complete their background screening.

The email option would instead email the candidate with a tokenized link to complete their background screening in Screening Direct.

{
    "id": "0020000008675309",
    "packageId": "161161",
    "candidateId": "57b8e8a9-bc8d-4a0e-9669-dbf89689c1ee",
    "status": "new",
    "result": "n/a",
    "invite": {
        "method": "link",
        "link": "https://qaworkforce.sterlingdirect.com/Account/Begin?PORTALDATA=yoDfSLYHSaTWCT6m25fPdfFtVXkMYlYeMKB1HVoVeISF0g1%7c0dq6jJADYm%7cWZVAC4Y4B8JL39u4OImvAj%2f4iLF3ABOnu2tpsPnDcqFsnfRc%3d"
    },
    "links": {
        "admin": {
            "web": "https://qasecure.sterlingdirect.com/sys/OneClick.aspx?METHOD=BGCHECK_PRTREPORT&CUSTID=Yvo0Re9cZczgNovyouJXWA%3d%3d&BGORDERID=tXMMH2L7L6ePzQ0myUvGng%3d%3d"
        }
    },
    "reportItems": [],
    "submittedAt": "2017-01-20T15:06:43Z",
    "updatedAt": "2017-01-20T15:06:43Z"
}

{
    "id": "0020000008675309",
    "packageId": "85685",
    "candidateId": "57b8e8a9-bc8d-4a0e-9669-dbf89689c1ee",
    "status": "PreDraft",
    "result": "Pending",
    "invite": {
        "method": "email"
    },
    "links": {
        "admin": {
            "web": "https://qasecure.sterlingdirect.com/sys/OneClick.aspx?METHOD=BGCHECK_PRTREPORT&CUSTID=tRi9fXj3E4zXUYZerPchlg%3d%3d&BGORDERID=UvDTODPDYmGQrF%7cDKpYSVA%3d%3d"
        }
    },
    "reportItems": [],
    "submittedAt": "0001-01-01T00:00:00Z",
    "updatedAt": "2019-05-24T15:01:00Z"
}

Invite Experience

Candidates invited via email will be met with a message that also includes the temporary password as mentioned above.

Both methods can be fully tested entirely in the integration testing environment.

🚧

Multiple Invites

invite cannot be retried, so every new call made to the /screenings endpoint with an invite method will begin an entirely new screening.