uCheck
Introduction
uCheck provide their clients with an online background checking service which can be accessed via their own platform, but the Seven20 integration makes use of uCheck's API to allow Seven20 users to request background checks and receive the results without having to leave the Seven20 platform.
Currently the Seven20 uCheck integration only supports DBS checks; to use the integration for other background checks please contact the Seven20 product team.
The integration works within Seven20's Compliance framework - during the recruitment process, a DBS check can be requested for candidates on an individual basis, including an option for whether the cost of the check is paid by the requester or the candidate.
The candidate will then receive an email with a URL to access uCheck's online platform and provide the required personal details and supporting documentation. Once the DBS check has been completed the integration will automatically retrieve the overall status of the check, along with a detailed report which is saved as a PDF within Seven20.
Due to the sensitive nature of the data involved in background checks, uCheck operate a strict security policy around third-party integrations so it is advised to contact them as soon as possible to ensure that any technical requirements, NDAs etc. are resolved ahead of go-live.
Implementation guide
Sending requests to uCheck
uCheck requests are made using a Compliance Request (seven20__Compliance_Request__c) created from a Compliance (seven20__Compliance__c) record.
To trigger a request to be sent, a Compliance Request record must be created or updated with the following conditions:
- Record type set to the packaged record type uCheck
- Internal Status (seven20__Internal_Status__c) set to Queued
- All required fields are set
The seven20__uCheck_Applicant_Pay__c required field can be set to TRUE or FALSE - if TRUE, the candidate will be required to make a payment in order to complete the background check process.
Sending of requests happens asynchronously so there may be a delay before completion.
If the record is sent successfully the Internal Status field will be set to Sent and the External Id (seven20__External_Request_Id__c) field will be populated with the tracking Id returned by uCheck.
If the request fails, Internal Status will be set to Error and the Error (seven20__Error__c) field will be populated with details of the error. Possible errors include validation failures caused by a missing required field or an API error returned by uCheck.
Results
Unlike other Seven20 integrations, uCheck does not use webhooks to provide third parties with updates. Instead, DBS check results must be retrieved by a scheduled apex job.
The External Status (seven20__External_Status__c) field will hold the overall result retrieved from uCheck. This will be one of two values:
- Clear: Represents a clear check
- Wait: Wait to see the report
Once a result has successfully been retrieved, the uCheck HR Ref (seven20__uCheck_HR_Ref__c) field will be populated. The value is provided by uCheck and acts as an identifier in their system.
Reports
Once a result has been retrieved, the Report Status (seven20__Report_Status__c) field will be set to Queued, and an automatically queued asynchronous apex job will then retrieve the PDF report when resources are available.
There is a wait of approximately 1 minute between each report being retrieved i.e. if 5 compliance requests were waiting for reports it would take at least 5 minutes before the final report is retrieved.
If the report is successfully retrieved, Report Status will be set to Retrieved and the report will be linked to both the Compliance Request record and the related Compliance record.
If the report retrieval fails, Report Status will be set to Error and the Error field will be populated with details of the error.