Skip to main content

FaceCreateParms

Face Biometric Parameters for a user.

Properties

NameTypeDescriptionNotes
applicant_idstrThe Onfido applicant UUID. Used to link the Face Biometric to the correct applicant. Applicable for server stored biometric web flows.[optional]
deliver_activation_emailboolIf set to true, an activation email will be sent to the user. Applicable only for mobile flows.[optional]
encrypted_biometric_tokenFaceEncryptedToken[optional]
return_qr_codeboolIf set to true, the response will include a QR code for activation. Applicable only for mobile flows.[optional]
workflow_run_idstrThe Onfido workflow run UUID. Used to link the Face Biometric to the correct workflow run. Applicable for server stored biometric web flows.[optional]

Example