1# @ohos.userIAM.faceAuth (人脸认证) 2 3提供人脸录入相关接口。 4 5> **说明：** 6> 7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8> 9> 本模块接口为系统接口。 10 11## 导入模块 12 13```js 14import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; 15``` 16 17## FaceAuthManager 18 19人脸认证管理器对象。 20 21### constructor 22 23constructor() 24 25表示获取人脸认证管理器对象。 26 27**系统能力：** SystemCapability.UserIAM.UserAuth.FaceAuth 28 29**返回值：** 30 31| 类型 | 说明 | 32| ---------------------- | -------------------- | 33| [FaceAuthManager](#faceauthmanager) | 人脸认证管理器对象。 | 34 35**示例：** 36 37```js 38import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; 39 40let faceAuthManager = new userIAM_faceAuth.FaceAuthManager(); 41``` 42 43### setSurfaceId 44 45setSurfaceId(surfaceId: string): void; 46 47该接口仅用于在录入人脸时，设置人脸预览界面 [XComponent](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid) 持有 Surface 的 ID，需要配合[人脸录入接口](./js-apis-osAccount.md#addcredential8)来使用。 48 49**系统能力：** SystemCapability.UserIAM.UserAuth.FaceAuth 50 51**需要权限：** ohos.permission.MANAGE_USER_IDM 52 53**参数：** 54 55| 参数名 | 类型 | 必填 | 说明 | 56| -------------- | ---------------------------------- | ---- | -------------------------- | 57| surfaceId | string | 是 | [XComponent](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid) 持有 Surface 的 ID。 | 58 59以下错误码的详细介绍请参见[用户认证错误码](../errorcodes/errorcode-useriam.md) 60 61**错误码：** 62 63| 错误码ID | 错误信息 | 64| -------- | ------- | 65| 201 | Permission verification failed. | 66| 202 | The caller is not a system application. | 67| 12700001 | The operation is failed. | 68 69**示例：** 70 71```js 72import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; 73 74// 该surfaceId应该从XComponent控件获取，此处仅用作示例。 75let surfaceId = "123456"; 76let manager = new userIAM_faceAuth.FaceAuthManager(); 77try { 78 manager.setSurfaceId(surfaceId); 79 console.info("set surface id success"); 80} catch (e) { 81 console.error("set surface id failed, error = " + e); 82} 83``` 84