Skip to main content

Create a Face Biometric for a user

POST 
/api/web/v2/users/:userid/face

Create a Face Biometric for the specified user. Caller requires the FACE:ADD permission.
The Face Biometric can be created using either the web flow or the mobile flow.
If using the web flow, the Face Biometric can optionally use the Onfido applicantId and workflowRunId to link the Face Biometric to the correct Onfido applicant and workflow run.
If using the mobile flow, setting deliverActivationEmail to true will send an activation email to the user with instructions to download the mobile app and complete activation.
Setting returnQRCode to true will include a QR code in the response that can be scanned by the user to start the activation process.
If using the IDaaS stored biometric web flow, the encryptedBiometricToken parameter is required and must include both the encrypted biometric token and the customer user ID used to create the token in Onfido.

Request​

Responses​

Successful