人脸实名认证API文档
  1. H5权威源实人认证
人脸实名认证API文档
  • 人脸实名认证API文档
  • API_V1.0
    • 人脸认证
      • 提交实名数据
      • 查询实名结果
    • 视频活体检测
      • 提交实名数据
      • 查询实名结果
    • 活体检测人脸认证
      • 提交实名数据
      • 查询实名结果
  • API_V2.0
    • H5权威源实人认证
      • 提交实名数据
        POST
      • 查询实名结果
        POST
      • notifyurl结果回调(post)
        POST
      • returnurl结果回调(get)
        GET
  1. H5权威源实人认证

提交实名数据

POST
https://face.ojwyun.cn/apiV2/initialize_1000

请求参数

Header 参数
Authorization
string 
必需
Authorization:KEYCODE {这里填KEY}
示例值:
KEYCODE 123456789
Body 参数application/json
name
string 
姓名
必需
idcard
string 
身份证号码
必需
type
string 
实名认证类型
必需
默认值:
1
示例值:
123'1' => '快捷认证(活体+实人认证,跳过用户身份录入流程)', '2' => '身份证OCR+活体+实人认证', '3' => '填写/身份证OCR+活体+实人认证',
returnurl
string 
同步跳转地址,用户完成验证、取消验证、或验证超时后,由FaceID服务器请求客户服务器的URL。(推荐为HTTPS协议,如果为HTTP则用户需要通过签名自行校验数据可信性,回调方法为Post)
可选
示例值:
https://face.ojwyun.cn/returnurl
notifyurl
string 
异同通知地址,用户完成或取消验证后网页跳转的目标URL。(回调方法为Post)
必需
示例值:
https://face.ojwyun.cn/notifyurl
txtBgColor
string 
页面按钮背景颜色
可选
默认值:
#cccccc
示例值:
#cccccc
pageBgColor
string 
页面背景颜色
可选
默认值:
#eeeeee
示例值:
#eeeeee
pageTitle
string 
实名网页title
可选
示例值:
xxx实人认证
livingType
string 
可组合活体动作类型
可选
默认值:
3
示例值:
26可组合活体动作类型,如13为先远近后摇头,推荐用动作组合,默认为3(1:远近,2: 眨眼,3:摇头,4:点头,6:炫彩)
示例
{
    "name": "张三",
    "idcard": "123456789123456789",
    "type": "1",
    "returnurl": "https://face.ojwyun.cn/returnurl",
    "notifyurl": "https://face.ojwyun.cn/notifyurl",
    "txtBgColor": "#cccccc",
    "pageBgColor": "#eeeeee",
    "pageTitle": "xxx实人认证",
    "livingType": "26"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://face.ojwyun.cn/apiV2/initialize_1000' \
--header 'Authorization: KEYCODE 123456789' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "张三",
    "idcard": "123456789123456789",
    "type": "1",
    "returnurl": "https://face.ojwyun.cn/returnurl",
    "notifyurl": "https://face.ojwyun.cn/notifyurl",
    "txtBgColor": "#cccccc",
    "pageBgColor": "#eeeeee",
    "pageTitle": "xxx实人认证",
    "livingType": "26"
}'

返回响应

🟢200成功
application/json
Body
code
string 
返回码
必需
msg
string 
结果描述
必需
token
string 
本次实名的token
可选
url
string 
实名页面地址,可生成二维码
可选
示例
{
    "code": "200",
    "msg": "提交成功",
    "token": "850452bbfe85c94d4771d194afb46a91",
    "url": "https://face.ojwyun.cn/index/face"
}
上一页
查询实名结果
下一页
查询实名结果
Built with