Private FaceMatch

When verifying a user, you can request ZKPassport to conduct a Private FaceMatch of the user. Prior to completing the verification, ZKPassport makes the user perform a face scan using their device camera and compares it to the photo on their ID. If the face matches, the verification process continues. The whole process is conducted locally via ML models running directly on the user's device.

The FaceMatch mode can be strict or regular. The strict mode triggers a more extensive liveness check to prevent spoofing (e.g. using someone else's photo or holding the ID photo in front of the camera), while the regular mode does not provide the same level of protection but is faster.

This example uses the @zkpassport/ui card.

React

import { ZKPassportQRCode } from "@zkpassport/ui/react";

<ZKPassportQRCode
  name="ZKPassport"
  logo="https://zkpassport.id/logo.png"
  purpose="Prove you are the person on the ID"
  scope="facematch"
  // .facematch() without arguments uses the regular mode
  query={(queryBuilder) => queryBuilder.facematch("strict").done()}
  onResult={({ verified, result }) => {
    if (verified) {
      console.log(result.facematch.passed ? "FaceMatch passed" : "FaceMatch failed");
    } else {
      console.log("Verification failed");
    }
  }}
/>;

Vanilla JS

import { mount } from "@zkpassport/ui";

mount(document.getElementById("zkpassport"), {
  name: "ZKPassport",
  logo: "https://zkpassport.id/logo.png",
  purpose: "Prove you are the person on the ID",
  scope: "facematch",
  // .facematch() without arguments uses the regular mode
  query: (queryBuilder) => queryBuilder.facematch("strict").done(),
  onResult: ({ verified, result }) => {
    if (verified) {
      console.log(result.facematch.passed ? "FaceMatch passed" : "FaceMatch failed");
    } else {
      console.log("Verification failed");
    }
  },
});