v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Access Credentials

Enable Face Unlock with Mobile Enrollment Invitation

Enable face unlock for a user by sending them an invitation to enroll their face via mobile device. An email will be sent to the user with a link to complete the enrollment process. If the user already has a face credential and overwrite is False, the request will fail. When overwrite is True, the invitation is sent and the user can upload a new photo which will replace the existing credential.

post/v2/access/external_users/{external_id}/face_unlock/invite

Path parameters

external_idstring required

Request body

invitation_methodsstring[]

Methods to send invitation through (email, sms). Default is ["email", "sms"].

Response

ok