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