Applicants

The first step in the process is to create an applicant. An applicant will be a person whose face you want to search against. You can create multiple applicants, with each having one facial image added to it.

Request body

Adding a payload is optional in this request. But if you do opt to send a payload, you can directly add a face to the applicant upon creation of the applicant.

Response

The response generates an applicant id and will include the face if added in the request:

Add Face

Once an applicant has been created, you can then add a face of an individual to the applicant.

Request body

When adding a face to the applicant, you can either use an image that you already possess of an individual, or you can use an image that Yoti captured of an individual in a previous Yoti identity verification session.

When using an image from a previous identity verification session, you need to supply the session id and media id that is linked to that image.

Response

You will receive a unique id for the face upon a successful request:

Error Responses