Configure the search
The final step would be to create an identity verification session while configuring the Face search. You can continue to use the Request builder to interact with our API.
Request body
More details regarding the session creation request can be found here.
Searching against multiple pools may incur additional cost.
The FAMILIAR_FACE_SEARCH is the check that needs to be configured for this Face search service. Within this check, there is a config that needs to be provided. The pool_id will correspond with the pool of applicants that has been created, and the approval criteria can be set to MATCH or NO_MATCH.
Approval criteria | Description |
|---|---|
MATCH | We will approve this check if the user undergoing the session matches one of the applicants in the pool. |
NO_MATCH | We will approve this check if the user undergoing the session does not match one of the applicants in the pool. |
Response
If the request is successful and a session is generated the API will send a response in the form:
Client Side View
The next step is to load the Yoti client-side SDK. To do this, you need the following 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:
Got a question? Contact us here.