Initialize
初始化
服务地址:
中国香港
输入参数
只看必填
ProductCode要接入的产品方案
MerchantBizId商户侧自定义的业务唯一标识
MetaInfoMetainfo环境参数
DocType证件类型
MerchantUserId您自定义的用户ID
SceneCode场景码
FacePictureBase64人脸照片Base64编码
FacePictureUrl人脸照片地址
Crop是否裁剪
Ocr是否开启OCR
IdFaceQuality人脸图片质量
IdSpoof是否启用证书防伪检测
ReturnUrl端侧回调地址
Authorize是否开启身份权威核验
DocScanMode证件采集拍照模式
ProductFlow支持卡证和人脸顺序编排:
CallbackUrl认证结果的回调通知地址
CallbackToken安全Token
LanguageConfig语言配置(IDV产品入参)
SecurityLevel代表认证流程不同安全水位的模式
StyleConfig
ExperienceCode
DocVideo
Model
IdThreshold
ShowAlbumIcon
ShowOcrResult
ShowGuidePage
ProcedurePriority
AppQualityCheck
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

请求参数

字段名称字段详情
ProductCodestring

要接入的产品方案。取值为展开详情

示例值:KYC_GLOBAL
MerchantBizIdstring

商户侧自定义的业务唯一标识,用于后续定位排查问题使用。支持字母和数字的组合,长度最长 32 位,请确保唯一。

示例值:e0c34a***353888
MetaInfostring

Metainfo 环境参数,需要通过客户端 SDK 获取。

示例值:{\"bioMetaInfo\":\"4.1.0:2916352,0\",\"deviceType\":\"web\",\"ua\":\"Mozilla/5.0 (Macintosh
DocTypestring

证件类型,以 8 位数字组合作为唯一标识展开详情

示例值:​01560000
MerchantUserIdstring

您自定义的用户 ID,或者其他可以识别特定用户的标识,例如手机号码、邮箱地址等。强烈建议对该字段的值进行预先脱敏,例如对值进行哈希处理。

示例值:1221****6543
SceneCodestring

场景码。(IDV 产品入参)

示例值:123****123
FacePictureBase64string

人脸照片 Base64 编码。如果您选择 FacePictureBase64 方式传入人脸照片,请注意检查照片大小,不要传入超过 1 MB 的照片。展开详情

示例值:Base64
FacePictureUrlstring

人脸照片地址。公网可访问的 HTTP、HTTPS 链接。当 productCode 为 FV_GLOBAL 时,和参数 FacePictureBase 选择其中之一传入

示例值:***
Cropstring

是否裁剪。(IDV 产品入参)

示例值:N
Ocrstring

是否开启 OCR。(IDV 产品入参)

示例值:Y
IdFaceQualitystring

人脸图片质量。(IDV 产品入参)

示例值:Y
IdSpoofstring

是否启用证书防伪检测。(IDV 产品入参)

示例值:Y
ReturnUrlstring

端侧回调地址。

示例值:http*****
Authorizestring

是否开启身份权威核验,目前仅适用于中国大陆二代身份证(IDV 产品入参)

示例值:Y
DocScanModestring

证件采集拍照模式。展开详情

示例值:manual
ProductFlowstring

支持卡证和人脸顺序编排:展开详情

示例值:DOC_FACE
CallbackUrlstring

认证结果的回调通知地址,回调请求方式默认为 GET,回调地址必须以 https 开头。平台在完成认证后会回调该地址,并自动添加 transactionId、passed 和 subcode 字段。

示例值:https://www.aliyun.com?callbackToken=1000004826&transactionId=shaxxxx&passed=Y&subCode=200
CallbackTokenstring

安全 Token,用于防重复、防篡改校验。如果传入该参数会在回调地址显示 CallbackToken 字段。

示例值:7ca5c68d869344ea8eeb30cdfd544544-6358700
LanguageConfigstring

语言配置(IDV 产品入参)

示例值:en
SecurityLevelstring

代表认证流程不同安全水位的模式,可选值:展开详情

示例值:01
StyleConfigstring
ExperienceCodestring
DocVideostring
Modelstring
IdThresholdstring
ShowAlbumIconstring
ShowOcrResultstring
ShowGuidePagestring
ProcedurePrioritystring
AppQualityCheckstring

返回参数

字段名称字段详情
RequestIdstring

Id of the request

示例值:4EB35****87EBA1
Codestring

返回码

示例值:Success
Messagestring

返回信息

示例值:success
Resultobject

返回结果

变更历史
变更时间变更内容概要操作
2024-11-29
新增请求参数AppQualityCheck
2024-11-19
新增请求参数ProcedurePriority
2024-09-18
新增请求参数ShowGuidePage
2024-08-23
新增请求参数ShowAlbumIcon
新增请求参数ShowOcrResult
2024-06-28
新增请求参数DocVideo
新增请求参数Model
新增请求参数IdThreshold
2024-06-20
新增请求参数ExperienceCode
2024-04-17
新增请求参数StyleConfig
2024-03-14
删除请求参数FlowType
删除请求参数ServiceLevel
删除请求参数OperationMode
删除请求参数Pages
删除请求参数ProductConfig
2024-02-02
变更请求参数FacePictureBase64
新增请求参数SecurityLevel
2024-01-18
新增请求参数LanguageConfig