H5接入文档

• 如要在小程序集成H5，请参考小程序集成H5说明
• 如要在APP中集成H5，请参考APP集成H5说明

1. 请求域名

https://h5-v2.kych5.com

2. 拼接URL

URL示例：https://h5-v2.kych5.com?accessKeyId=xxx&secretAccessKey=xxx&sessionToken=xxx&configId=xxx&bytedToken=xxx&lng=xxx

• accessKeyId、secretAccessKey、sessionToken：临时密钥，必填字段，用于服务端接口鉴权，具体的获取方式参考获取临时密钥（STS）。
• configId：固定参数套餐ID，必填字段，有效期默认为15min，具体的获取方式参考下方【配置参数说明】。
• bytedToken：可选字段，当业务场景为直接进入活体识别时，需要调用服务端接口CertH5Token获取。
• lng：可选字段，表示页面语言。目前支持简体(zh)、繁体(zh-Hant)、英文(en)。

3. 配置参数说明

提供可选的配置参数，适配多样化的客户需求和业务场景，调用服务端接口（参考CertH5ConfigInit ）生成configId并拼接到URL参数上。

ConfigID配置示例

下面会列出几种常见接入场景的配置数据格式，便于业务侧快速接入。

示例1： 完整的默认参数模版（推荐）。

const postData = {
  h5_config: {
    type: '0',
    theme_color: 'rgba(56, 123, 255, 1)',
    show_guide: '1',
    show_result: '1',
    protocol_name: '',
    protocol_link: '',
    enable_record: '1',
    redirect_url: 'https://xxx.com',
  },
  liveness_config: {
    ref_source: '1',
    liveness_type: 'motion',
    liveness_timeout: 10,
    motion_list: ['0', '1', '2', '3'],
    fixed_motion_list: [],
    motion_count: 2,
    max_liveness_trial: 10,
  },
  ...
};

示例2： 业务侧已存有用户资料（身份照片或者身份信息），不需要使用身份认证服务提供的证件照片上传功能和身份信息输入功能。

const postData = {
  h5_config: {
    type: '3',
    // 其余参数根据实际情况配置，注意必填参数
    ...
  },
  liveness_config: {
    // 1. 如果业务侧使用一张基准图发起认证，则配置为0
    ref_source: '0',
    // 2. 如果业务侧使用身份证号和姓名发起认证，则配置为1
    ref_source: '1',
    // 其余参数根据实际情况配置，注意必填参数
    ...
  },
  ...
};

示例3： 业务侧需要将认证数据存储到自定义TOS

const postData = {
  h5_config: {
    // 其余参数根据实际情况配置，注意必填参数
    ...
  },
  liveness_config: {
    // 其余参数根据实际情况配置，注意必填参数
    ...
  },
  // Tos参数的获取，参考火山引擎文档：https://www.volcengine.com/product/TOS
  tos_config: {
    sts_ak: '',
    sts_sk: '',
    sts_token: '',
    bucket: '',
    endpoint: '',
    region: '',
  },
  ...
};

4. 认证结束

当结束认证后，身份认证H5会在redirect_url地址后面拼接相关的参数，业务侧可解析参数获取认证结果。

/** 拼接示例 **/
${redirect_url}?resultCode=xxx&algorithmBaseRespCode=xxx&reqMeasureInfoValue=xxx&bytedToken=xxx

认证返回参数说明

客户端错误码

算法端错误码

服务端错误码

服务端子错误码

1. 设备兼容情况

身份认证H5的动作活体功能使用了WebRTC相关能力，如果不支持则降级到录制视频的方式进行认证。
WebRTC 介绍

Android
通过浏览器内核和版本号来确认对WebRTC的支持。
IOS
WKWebView从iOS 14.3 (Beta)开始提供对WebRTC的支持。
Safari从iOS 11开始支持WebRTC。

2. 如果出现无法打开摄像头、无法录制、无法完成认证等情况，应该如何处理？

由于某些设备或者浏览器环境的兼容性，导致无法完成认证流程，但是不清楚具体哪里出问题了，所以将整个认证流程中涉及到的一些浏览器标准Web API调用，单独剥离出来，供用户手动测试该设备是否正常。
方式一： 访问地址： https://h5-v2.kych5.com/checkapi
方式二：可以通过双击页面底部文字进入检测页面：