个人认证-获取个人认证链接

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

mode

enum<string>

实名认证模式

可选

IVS（三要素）、FACE（人脸认证）、BANK（银行卡认证），默认为DEFAULT（不指定认证模式，默认使用可使用的所有认证）

枚举值:

IVSFACEBANK

user

object

待认证用户信息

必需

contact

string

联系方式

必需

contactType

enum<string>

联系类型

必需

MOBILE（手机号），EMAIL（邮箱），EMPLOYEEID（员工ID），NUMBER（员工编号），BIZID（用户在对接方系统的唯一标识）

枚举值:

MOBILEEMAILEMPLOYEEIDNUMBERBIZID

paperType

enum<string>

证件类型

可选

枚举值:

IDCARDPASSPORTHKMPMTPS

username

string

指定用户认证名称

可选

idCardNo

string

指定用户身份证号

可选

bankNo

string

指定用户银行卡号

可选

bankMobile

string

指定用户银行卡预留手机号

可选

callbackUrl

string

认证回调地址

可选

callbackPage

string

跳转页面地址

可选

otherModes

array[string]

降级认证方式可选项

可选

三要素-IVS，人脸认证-FACE，银行卡认证-BANK，人工审核-MANUAL

枚举值:

IVSFACEBANKMANUAL

modifyFields

array[string]

认证可修改项

可选

姓名-USERNAME，身份证-IDCARDNO，银行卡号-BANKNO，银行卡预留手机号-BANKMOBILE

枚举值:

USERNAMEIDCARDNOBANKNOBANKMOBILE

lang

enum<string>

指定页面语言

可选

cn（中文）、en（英文）；默认为当前认证人在契约锁设置的语言

枚举值:

cnen

pageStyle

object

页面风格

可选

themeColor

string

自定义页面主题色

可选

RGB颜色(16进制)，默认取业务系统令牌配置的主题色

示例

{
  "mode":"DEFAULT",

 
  "user":{
    "contact":"19000009093",
    "contactType":"MOBILE"
  },
  "username":"jack",
  "callbackUrl":"http://www.baidu.com"

}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/personalauth' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "mode":"DEFAULT",

 
  "user":{
    "contact":"19000009093",
    "contactType":"MOBILE"
  },
  "username":"jack",
  "callbackUrl":"http://www.baidu.com"

}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

result

object (PersonAuthResponse)

认证信息

必需

authUrl

string

认证链接

可选

authId

string

认证请求ID

可选

用于查询认证结果

示例

{
    "result": {
        "authUrl": "https://auth.qiyuesuo.me?ticket=YSNcRjAub272oM%2FsNSnFUQwlnHqPSHbcDet5b3ZNVD291ZzlNk3yNM2MmTIfOnLk&channel=OPEN_V2",
        "authId": "efa2b4fb-d083-4f8b-adf2-120d8035cc84"
    },
    "code": 0,
    "message": "SUCCESS"
}