Face Search

Overview

Yoti allows you to add your own pool of applicants or faces to our Identity Verification API. You can then perform face searches against this pool and the user undergoing identity verification check. If a match is found, you will be notified in the session response.

There are a few steps to use this service:

1. Create the applicants
2. Add a face for each applicant
3. Create an applicant pool
4. Add applicants to the applicant pool
5. Configure a Face Search when creating an identity verification session

Authentication

From here on, each endpoint requires an RSA-signed request for Authentication. This can be constructed via one of our backend SDKs. The Yoti SDK exposes a simple request builder class to support the authentication process, and the examples provide snippets of this usage in each endpoint code snippet. You will need your Yoti SDK ID and application key pair for this process.

Please use our Yoti SDKs to automatically build the relevant request. The Yoti SDKs are available via popular dependency management systems.

npm install yoti

const { RequestBuilder, Payload } = require("yoti");

​

const payload = {}; // JSON payload

​

const request = new RequestBuilder()

  .withBaseUrl("https://api.yoti.com/idverify/v1")

  .withPemFilePath("<YOTI_KEY_FILE_PATH>") // file path to PEM file

  .withEndpoint("/")

  .withPayload(new Payload(payload))

  .withMethod("POST")

  .withQueryParam("sdkId", "<YOTI_CLIENT_SDK_ID>")

  .build();

​

// get Yoti response

const response = await request.execute();