HTTP/HTTPS
请求协议
OAPI接口服务市场 / OpenAPI / 获取个人实名认证地址
获取个人实名认证地址
接口地址:https://www.oapi.cc/store/App.Esign.GetPersonVerifyUrl
接口描述: 此接口返回个人实名认证页面url,接入方拿到url后在浏览器中打开认证页面
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 必须 | - | 访问令牌,生成令牌可使用App.Auth.ApplyToken接口 | |
customer_id | 字符串 | 必须 | - | 客户编号,使用App.Esign.AccountRegister接口获得 | |
page_modify | 枚举类型 | 必须 | 1 | 范围:1/2 | 是否允许用户页面修改 1:允许 2:不允许 |
customer_name | 字符串 | 可选 | - | 姓名 | |
customer_ident_type | 枚举类型 | 可选 | 0 | 范围:0/1 | 是否支持其他证件类型 0:身份证 1:其他 |
customer_ident_no | 字符串 | 可选 | - | 证件号码:cert_type=0身份证号cert_type=1护照号cert_type=B港澳居民来往内地通行证号cert_type=C台湾居民来往大陆通行证号 | |
mobile | 字符串 | 可选 | - | 手机号码 | |
id_photo_optional | 枚举类型 | 可选 | 2 | 范围:0/1/2 | 是否需要上传身份照片 0:只需要头像面 1:头像面与国徽面都需要 2:都不需要 |
cert_flag | 枚举类型 | 可选 | 1 | 范围:0/1 | 是否认证成功后自动申请实名证书 0:不申请 1:自动申请 |
cert_type | 枚举类型 | 可选 | 0 | 范围:0/1/B/C | 证件类型 0:身份证 1:护照 B:港澳居民来往内地通行证 C:台湾居民来往大陆通行证 (默认为0,仅当支持其他证件时,证件类型1/B/C接口允许同步传参) |
is_mini_program | 枚举类型 | 可选 | 0 | 范围:0/1 | 是否小程序认证(0 否,1 是) |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.transactionNo | 字符串 | 交易号(需要保存,用于证书申请和实名认证查询) |
data.url | 字符串 | 地址(需要保存,遇到中途退出认证或页面过期等情况可重新访问)(需要Base64解码) |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 必须 | |
customer_id | 必须 | |
page_modify | 必须 | |
customer_name | 可选 | |
customer_ident_type | 可选 | |
customer_ident_no | 可选 | |
mobile | 可选 | |
id_photo_optional | 可选 | |
cert_flag | 可选 | |
cert_type | 可选 | |
is_mini_program | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/App.Esign.GetPersonVerifyUrl.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
500 | 表示服务端内部错误 |
本文档生成时间:2025-05-04 23:34:15