This activation guide is for both Jobtrain and JTGO, both require the initial setup to be done in YOTI first and then activated in ATS control & client side.
Before the Yoti integration can be connected to the client’s Jobtrain system, the client must have a Yoti account created, following the Yoti Setup Guide instructions
Step 1 of ‘Activating the YOTI Application’ will provide the client SDK required to configure the integration.
Step 2 of ‘Activating the YOTI Application’ (generate key pair) will download the Pem File required to configure the integration.
Both steps are detailed in the Yoti Setup Guide instructions.
Once you have completed the full setup instructions the Yoti integration can then be configured in ATS Control:
ATS Control
In ATS > Integrations > Identity Checks > Yoti tile
- Toggle on ‘Enable Yoti integration’
- Add the Client SDK ID (obtained in Step 1 of the Yoti Setup)
- Using Notepad, open the file that was downloaded from Yoti (obtained in Step 2 of the Yoti setup) - this must be opened as plain text without any formatting.
- Copy and paste the entire code from Notepad into the Pem Path area in ATS Control.
Client Configuration
Add in ‘yoti-call-back-url’ and ensure this includes the client url at the beginning.
Steps:
- Client Configuration
- Add new
- Name = yoti-call-back-url
- Value = <<clienturl>>/client/api/Integration/AddIdentityCheckProgressHistory
For example, PA Housing URL would be:
You will then need to ensure that the below information has been made active:
- Client Configuration
- Add new
- Name = yoti-is-live-mode
Value = true
Client SideSecurity Roles
- Go to Security Roles > Jobs & Talent Pools:
- Enable ‘Identity Check’ to allow the user access to invite candidates to complete the RTW Check.
- Enable ‘Identity Check Approval’ to allow the user to approve/decline the RTW Check received.
Application Statuses
General Settings
Add 3 new application statuses in Settings > General Settings > Candidate Application Statuses.
- Check Requested
- Check Completed
- Check Approved
If activating the feature for JTGO clients these should be named: - Invite to RTW Checks - RTW Check Approved - RTW Check Complete
System Customisation
Configure which application status is connected to which stage of the RTW process in System Customisation > Application Statuses
Emails
In System Settings > Communications,
Add 2 new emails:
- Candidate Invite to Check
- Check Complete - Notification to Approve
The merge field {RequestCheckURL} must be used in the Request Check email.
Example email content
Example Invite to check email:
Hi {CANDIDATES.FIRSTNAME},
In line with government guidance, we need you to verify your identity to confirm your right to work in the UK. It’s a simple, two-step process in which we ask you to capture an image of your ID document and a live selfie.
You can complete this online following this link: {RequestCheckURL}
Before you begin:
- Make sure you’ve got a valid UK or Irish passport (or Irish passport card) that’s in date.
- Make sure you capture the whole ID document in the image.
- Try to capture clear images without any glare. For best results, use your smartphone.
Please note: If you don’t have any of these, please don’t start the online process. Reply to this email instead.
Example notification to approver email:
Hi,
{CANDIDATES.FIRSTNAME} {CANDIDATES.LASTNAME} has now provided proof of their identity in relation to {JOBS.JOBREFERENCE} {JOBS.JOBTITLEFORCANDIDATES}.
Please log into Jobtrain to review the identity documents returned and confirm your approval that this is a likeness to the individual that you met at interview.
System Customisation
Configure which email is connected to which stage of the RTW process in System Customisation > Emails
