Title
Create new category
Edit page index title
Edit category
Edit link
Reference image
The face match check can also be used to match or authenticate a user by using an existing facial image (selfie)—for example, one previously obtained from a liveness check.
This check uses AI to compare the portrait from the ID document with the reference facial image and returns a confidence score.
Configure face match
Before triggering the face match check, you have to create an IDV session configured with a Face Match check. Additionally, a reference face image has to be uploaded against which the ID document portrait will be compared.
const { SessionSpecificationBuilder, RequestedDocumentAuthenticityCheckBuilder, RequestedTextExtractionTaskBuilder, RequestedFaceMatchCheckBuilder, SdkConfigBuilder} = require('yoti');// Face Match checkconst faceMatchCheck = new RequestedFaceMatchCheckBuilder() .withManualCheckFallback() .build();// Document authenticity checkconst documentAuthenticityCheck = new RequestedDocumentAuthenticityCheckBuilder() .withManualCheckFallback() .build();// Data Extractionconst textExtractionTask = new RequestedTextExtractionTaskBuilder() .withManualCheckFallback() .build();// Configuration for the client SDK (Frontend)const sdkConfig = new SdkConfigBuilder() .withSuccessUrl('/success') .withErrorUrl('/error') .withAllowHandoff(true) .build();// Buiding the Session with defined specification from aboveconst sessionSpec = new SessionSpecificationBuilder() .withClientSessionTokenTtl(600) .withResourcesTtl(90000) .withUserTrackingId('some-user-tracking-id') .withRequestedCheck(faceMatchCheck) .withRequestedCheck(documentAuthenticityCheck) .withRequestedTask(textExtractionTask) .withSdkConfig(sdkConfig) .build();Initialise the Yoti client
The included DocScan/IDV Client includes several helper methods to interact with the Yoti's API. You can initialise the client using your unique SDK ID and PEM file.
const path = require('path');const fs = require('fs');const { IDVClient } = require('yoti');const YOTI_CLIENT_SDK_ID = 'YOTI_CLIENT_SDK_ID';const YOTI_PEM = fs.readFileSync(path.join(__dirname, '/path/to/pem'));const idvClient = new IDVClient(YOTI_CLIENT_SDK_ID, YOTI_PEM);Create a session
You can use the createSession method from the above client to create a Yoti session. The session specification needs to be passed as an argument. After the session is successfully created, you will get a Session ID that can be used to retrieve the Session configuration.
let sessionId, sessionToken;idvClient .createSession(sessionSpec) .then((session) => { sessionId = session.getSessionId(); sessionToken = session.getClientSessionToken(); }) .catch((err) => { console.log(err) });const sessionConfig = await idvClient.getSessionConfiguration(sessionId);Create a Face Capture resource
Before uploading the reference face image, you have to create a Face capture resource. To do this, a Requirement ID from the Face Capture requirements needs to retrieved. This can then be used to create a face capture resource. If successful, you will receive a Resource Id.
const { CreateFaceCaptureResourcePayloadBuilder, UploadFaceCaptureImagePayloadBuilder,} = require('yoti');const resourceRequirements = sessionConfiguration.getCapture().getFaceCaptureResourceRequirements()[0];const requirementId = resourceRequirements.getId();const faceCapturePayload = new CreateFaceCaptureResourcePayloadBuilder() .withRequirementId(requirementId) .build();const faceCaptureResource = await idvClient.createFaceCaptureResource(sessionId, faceCapturePayload);const resourceId = faceCaptureResource.getId();Upload a reference image
To do accurate face match, a reference facial image of the user is required. You have to get the contents of this image which can then be uploaded using the Doc Scan Client. You also have to pass in the Resource Id retrieved earlier
const fs = require('fs');const imageBuffer = fs.readFileSync('path-to-selfie-jpeg');const faceCaptureImagePayload = new UploadFaceCaptureImagePayloadBuilder() .forJpegImage() .withImageContents(imageBuffer) .build();await idvClient.uploadFaceCaptureImage(sessionId, resourceId, faceCaptureImagePayload);Client-side view
The next step is to load the Yoti client-side SDK. To do this, you need the below parameters generated with the session creation request above:
- Session ID
- Session Token
We then utilise these to construct a Web URL which loads the Yoti Client SDK. The URL is in the following format:
https://api.yoti.com/idverify/v1/web/index.html?sessionID=<sessionID>&sessionToken=<sessionToken>Once the above URL launches in a web browser, it will take the user through the document capture flow. For more detailed steps, please refer to the Launch the user view page.
Retrieve results
Once a session has been completed, the associated checks' results and resources can be retrieved using the session ID. Each check would contain a recommendation and a breakdown. The resources however are not directly included in the results, but contain a media ID. This can be used to fetch the actual media resource.
Retrieve checks
idvClient.getSession(sessionId).then(sessionResult => { const state = sessionResult.getState(); const faceMatchChecks = sessionResult.getFaceMatchChecks(); faceMatchChecks.map(check => { const id = check.getId(); const state = check.getState(); const resourcesUsed = check.getResourcesUsed(); const report = check.getReport(); const recommendation = report.getRecommendation().getValue(); const breakdown = report.getBreakdown(); breakdown.forEach(function(breakdown) { const subCheck = breakdown.getSubCheck(); const subCheckResult = breakdown.getResult(); }); })}).catch(error => { console.log(error); // handle error})Retrieve media
idvClient.getMediaContent(sessionId, mediaId).then(media => { const buffer = media.getContent(); const mimeType = media.getMimeType(); const base64Content = media.getBase64Content(); // handle base64content or buffer}).catch(error => { console.log(error) // handle error})Got a question? Contact us here.