调用CreateVerifySetting创建认证场景配置。该操作等同于在控制台上新建认证场景。
请求方法:仅支持以HTTPS POST方法发送请求。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateVerifySetting |
要执行的操作。取值:CreateVerifySetting。 |
BizName | String | 是 | 用户注册 |
认证场景名称,支持中文、英文、数字、短划线(-),最多20个字符。 |
BizType | String | 是 | UserRegister |
认证场景标识,支持英文、数字、短划线(-),最多32个字符。 |
Solution | String | 是 | RPBasic |
要使用的认证方案的名称,例如RPBasic、RPBioOnly等。 |
GuideStep | Boolean | 否 | false |
是否使用系统默认的引导页。 |
PrivacyStep | Boolean | 否 | true |
是否使用系统默认的授权页。 |
ResultStep | Boolean | 否 | false |
是否使用系统默认的结果页。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BizName | String | 用户注册 |
认证场景名称。 |
BizType | String | UserRegister |
认证场景标识。 |
RequestId | String | D6163397-15C5-419C-9ACC-B7C83E0B4C10 |
本次请求的ID。 |
Solution | String | RPBasic |
认证方案名称。 |
StepList | List | ["GUIDE","PRIVACY","FACE_LIVENESS","TAKE_ID_PHOTO","RESULT"] |
认证步骤,GUIDE代表引导页,PRIVACY代表授权页,FACE_LIVENESS代表活体步骤,TAKE_ID_PHOTO代表拍身份证步骤,RESULT代表结果页。 |
示例
请求示例
https://cloudauth.aliyuncs.com/?Action=CreateVerifySetting
&BizType=UserRegister
&BizName=用户注册
&Solution=RPBasic
&GuideStep=false
&PrivacyStep=true
&ResultStep=false
&<公共请求参数>
正常返回示例
XML
格式
<CreateVerifySettingResponse>
<BizName type="string">用户注册</BizName>
<BizType type="string">UserRegister</BizType>
<RequestId type="string">D6163397-15C5-419C-9ACC-B7C83E0B4C10</RequestId>
<Solution type="string">RPBasic</Solution>
<StepList class="array">
<e type="string">GUIDE</e>
<e type="string">PRIVACY</e>
<e type="string">FACE_LIVENESS</e>
<e type="string">TAKE_ID_PHOTO</e>
<e type="string">RESULT</e>
</StepList>
</CreateVerifySettingResponse>
JSON
格式
{
"BizType": "UserRegister",
"BizName": "用户注册",
"RequestId": "D6163397-15C5-419C-9ACC-B7C83E0B4C10",
"StepList": [
"GUIDE",
"PRIVACY",
"FACE_LIVENESS",
"TAKE_ID_PHOTO",
"RESULT"
],
"Solution": "RPBasic"
}
错误码
访问错误中心查看更多错误码。