获取个人认证&授权链接

POST

/api/psnAuthUrl

V1.1.0V2.2.0

用于获取个人的认证授权页面链接，通过此链接个人用户可进行个人实名认证、资源授权等操作。

注意

用户授权有效期默认永久有效（100年）。

可以调用【获取个人授权信息】获取个人授权有效期和授权范围

可以调用【查询个人认证信息】查询个人的认证状态和个人openPsnId

个人认证方式2种（暂时不可控制认证方式）

个人信息+个人人脸OCR

个人信息+运营商三要素

设置页面中可选择的个人授权范围

get_psn_ident_info - 授权允许获取个人身份信息

get_psn_signature_info - 授权允许获取个人用户的签名资源

psn_sign_task_init - 授权允许代表个人发起合同

get_psn_sign_task_info - 授权允许获取个人用户的合同信息

get_psn_sign_task_file - 授权允许获取个人用户的合同文件

get_psn_template - 授权允许获取个人用户的模版

请求头格式

具体请求头参数，请查看公共请求格式

请求参数

Body 参数application/json

psnAuthConfig

object

个人授权配置项

必需

psnAccount

string | null

必需

个人账号标识(手机号) 与 openPsnId 必选一项。

openPsnId

string | null

必需

个人应用账号ID 与 psnAccount 必选一项

psnName

string | null

可选

个人姓名（选填），传此参会限制用户必须认证此姓名

psnIDCardType

string | null

可选

证件类型：证件类型 CRED_PSN_CH_IDCARD - 中国大陆居民身份证

psnIDCardNum

string | null

可选

证件号，跟证件类型关联，传此参会限制用户必须认证此证件号

psnInfo

object | null

个人身份信息

已废弃

authorizeConfig

object

必需

个人授权配置项授权，取消授权后需重新授权

authorizedScopes

array[string]

必需

设置页面中可选择的授权范围，数组
get_psn_ident_info - 授权允许获取个人身份信息
get_psn_signature_info - 授权允许获取个人用户的签名资源
psn_sign_task_init - 授权允许代表个人发起合同
get_psn_sign_task_info - 授权允许获取个人用户的合同信息
get_psn_sign_task_file - 授权允许获取个人用户的合同文件
get_psn_template - 授权允许获取个人用户的模版

redirectConfig

object | null

可选

认证完成重定向配置项

redirectUrl

string

跳转页面

必需

认证完成后跳转页面（需符合 https /http 协议地址）

redirectDelayTime

integer | null

重定向跳转延迟时间

可选

单位为秒。实名模式下（authorizedScopes不传或者没有具体的参数值）：默认延迟时间为 5秒。传 0 - 不展示实名结果页，认证完成直接跳转重定向地址传其他数字 - 展示实名结果页，倒计时5秒后，自动跳转重定向地址（只有5秒，没有其他秒数的控制）【注】当redirectUrl不传的情况下，该字段无需传入，认证完成结果页不跳转。

clientType

string

客户端类型

必需

h5-移动端适配 pc-PC端适配

accountId

string

集成方唯一标识

可选

V2.2新增集成方唯一标识

<= 64 字符

示例

{
    "psnAuthConfig": {
        "psnAccount": "19843425674",
        "openPsnId": null,
        "psnName": "吴娜",
        "psnIDCardType": "CRED_PSN_CH_IDCARD",
        "psnIDCardNum": "31757818410214807X",
        "psnInfo": {
            "psnName": null
        }
    },
    "authorizeConfig": {
        "authorizedScopes": [
            "get_psn_ident_info"
        ]
    },
    "redirectConfig": null,
    "clientType": "h5"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://api.pre-qiandun365.com/api/psnAuthUrl' \
--header 'Content-Type: application/json' \
--data-raw '{
    "psnAuthConfig": {
        "psnAccount": "19843425674",
        "openPsnId": null,
        "psnName": "吴娜",
        "psnIDCardType": "CRED_PSN_CH_IDCARD",
        "psnIDCardNum": "31757818410214807X",
        "psnInfo": {
            "psnName": null
        }
    },
    "authorizeConfig": {
        "authorizedScopes": [
            "get_psn_ident_info"
        ]
    },
    "redirectConfig": null,
    "clientType": "h5"
}'

返回响应

🟢200成功

application/json

Body

code

string

业务码

必需

msg

string

业务信息

必需

result

object

业务数据

必需

authUrl

string

必需

个人认证授权链接（有效期30天）

authFlowId

string

必需

本次认证授权流程ID

authCode

string

授权码

必需

accountId

string

集成方唯一标识

可选

success

boolean

是否成功

必需

string

时间戳

必需

logKey

string

调试日志key

必需

示例

{
    "result": {
        "authUrl": "https://saas-h5.pre-qiandun365.com/#/openPlatform/authorize/index?code=e4ylpyg8p98xzam6rr8f&appId=90",
        "authFlowId": "100003435",
        "authCode": "e4ylpyg8p98xzam6rr8f"
    },
    "code": "200",
    "msg": "成功",
    "logKey": "dafb3079",
    "ts": "1711420288018",
    "success": true
}

用户认证&授权流程

查询个人认证信息

获取个人认证&授权链接

个人认证方式2种（暂时不可控制认证方式）#

设置页面中可选择的个人授权范围#

请求头格式#

请求参数

示例代码

返回响应

个人认证方式2种（暂时不可控制认证方式）

设置页面中可选择的个人授权范围

请求头格式