OAPI接口服务市场 / OpenAPI / 获取个人实名认证地址

获取个人实名认证地址

接口描述: 此接口返回个人实名认证页面url,接入方拿到url后在浏览器中打开认证页面

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
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

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
500表示服务端内部错误

本文档生成时间:2025-05-04 19:44:40