Overview
Invite is an option that Sterling Talent Solutions provides to bridge the API to the SterlingONE platform. Using invite allows you to specify a method that a candidate can take to finish the screening process. SterlingONE 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, one-time use link that will expire without use after 10 minutes.The
{
"id": "0020000008675309",
"packageId": "161161",
"candidateId": "864109",
"status": "new",
"result": "n/a",
"submittedAt": "2017-01-20T15:06:43Z",
"updatedAt": "2017-01-20T15:06:43Z",
"invite": {
"method": "link",
"link": "https://portal.integration.talentwise.com/438a7d2ee6/ptl/ticketeda.php?ID=MTY5MDIzODA&code=7C3bGnsqq1Zw8jUQ&ticket=423829&&Sender=16902380&Email=deckarda7b83455-07e6-818f-d474-293605e7d663%40example.com&OverrideCandidateID=864109&KennectApiToken=TWFuIEkgbG92ZSB0YWNvcy4gVGhleSByZWFsbHkgYXJlIGp1c3Qgb25lIG9mIHRoZSBtb3N0IGlkZWFsIGZvb2RzIG9uIHRoZSBwbGFuZXQuIEV2ZW4gdGhlIGdyZWFzeSBzdHJlZXQgb25lcyBhcmUgYXdlc29tZS4gWW91J3JlIGF3ZXNvbWUgdG9vIGZvciBsb29raW5nIHRoaXMgdXAu"
},
"callback": {
"uri": "https://my-company.com/screenings-callback"
},
"adverseActions": []
}
{
"id": "0020000008675309",
"packageId": "161161",
"candidateId": "864109",
"status": "new",
"result": "n/a",
"submittedAt": "2017-01-20T15:06:43Z",
"updatedAt": "2017-01-20T15:06:43Z",
"invite": {
"method": "email"
},
"callback": {
"uri": "https://my-company.com/screenings-callback"
},
"adverseActions": []
}
Invite Experience
Candidates invited via email
will be met with this message that also includes the temporary password as mentioned above:
Candidates that are given an invite
link will be directed to this page to start the screening flow:
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 aninvite
method
will begin an entirely new screening.