Enroll a Face Without Using a Device

This endpoint is used to enroll a face without using a device by providing the API with an image.

Controlled Errors

Error CodeError Message
error_user_not_foundNo user found with the Id provided.
error_user_has_3d_faceThe user already has a 3D face registered in the system.
error_one_face_requiredNo faces or more than one face was detected in the image.
error_mask_detectedMask detected on face in image.
error_low_qualityFace in image is too low quality.

Any status codes returned that are not provided here are generic status codes that can be found here.

Body Params
string
required

Base64 encoded image

string
required

The Guid Id of the user whose face will be enrolled.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain