签盾开放平台-电子签约服务
  1. 开放接口
签盾开放平台-电子签约服务
  • 接入流程介绍
  • 应用创建流程
  • 前端接入文档
  • 开发前必读
    • 常用接口清单和关键流程
    • 公共请求格式
  • 帮助文档
    • 印章指定位置
    • 静默签使用说明
  • 实名认证
    • 个人认证
      • 个人认证项
        • 个人身份二要素核验
        • 个人运营商三要素核验
        • 个人人脸核验(H5适配)
        • 个人人脸核验查询
        • 发送短信验证码
        • 校验短信验证码
        • 个人银行卡四要素核验
      • 个人实名认证地址(页面)
    • 企业认证
      • 企业认证项
        • 企业四要素核验
        • 企业三要素核验
        • 发起打款认证(正向打款)
        • 验证打款金额(正向打款)
        • 查询打款进度(正向打款)
        • 企业经办人授权书认证-上传
        • 企业经办人授权书认证-查询
        • 查询打款银行信息
      • 企业实名认证地址(页面)
    • 查询认证信息
      GET
  • 用户管理
    • 个人用户
      • 修改个人用户
      • 创建已认证个人用户
      • 查询个人用户信息
    • 企业用户
      • 查询企业用户信息
      • 创建已认证企业用户
    • 创建未认证用户(暂不支持企业)
      POST
  • 文件相关
    • 上传文件
      POST
    • 基于模板生成文件
      POST
  • 合同相关
    • 通过文件发起合同
      POST
    • 查询签署方信息
      GET
    • 下载合同文件及附件
      GET
    • 合同查询
      GET
    • 获取合同签署链接(页面)
      POST
    • 无感签署(申请开放)
      POST
    • 获取拖章定位页面
      POST
  • 印章管理
    • 查询印章列表
    • 查询印章详情
    • 印章静默签授权地址(H5页面)
  • 接口回调
    • 回调接入文档
    • 获取回调信息
    • 回调成功确认
  • 开放接口
    • 短信验证码
      POST
    • 通知短信发送
      POST
    • 身份证OCR
      POST
    • 营业执照OCR
      POST
    • 银行卡OCR
      POST
  1. 开放接口

身份证OCR

POST
/open/api/ocr/idCard
V1.4.1
传入身份证照片,扫描识别身份证信息并返回,如果传的是正面照片只返回正面信息,如果传的是反面只返回反面信息
图片格式为 jpg或png,宽和⾼大于 8px,⼩于等于4000px,大小不能超过1MB
base64 / URL 同时存在时优先URL

请求参数

Body 参数application/json
imageBase64
string 
身份证图片的base64编码
可选
imageBase64 / imageUrl 二选一填入
imageUrl
string 
身份证图片的url地址
可选
imageBase64 / imageUrl 二选一填入
cardSide
enum<string> 
可选
卡面方向 (选填, 留空则自动判断)
枚举值:
frontback
示例
{
    "imageBase64": "string",
    "imageUrl": "string",
    "cardSide": "front"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'api.pre-qiandun365.com/api/open/api/ocr/idCard' \
--header 'Content-Type: application/json' \
--data-raw '{
    "imageBase64": "string",
    "imageUrl": "string",
    "cardSide": "front"
}'

返回响应

🟢200成功
application/json
Body
result
object 
必需
name
string 
姓名
必需
人像面
sex
string 
性别
必需
人像面
nation
string 
民族
必需
人像面
birth
string 
出生日期
必需
人像面
address
string 
地址
必需
人像面
psnIdCardNum
string 
身份证号码
必需
人像面
authority
string 
发证机关
必需
国徽面
validDate
string 
证件有效期
必需
国徽面
code
string 
必需
msg
string 
必需
logKey
string 
必需
ts
string 
必需
success
boolean 
必需
示例
{
    "result": {
        "name": "谢勤",
        "sex": "男",
        "nation": "汉",
        "birth": "1997/1/9",
        "address": "浙江省平阳县鳌江镇孙岙村四脚亭后路12号",
        "psnIdCardNum": "330326199701000000",
        "authority": "",
        "validDate": ""
    },
    "code": "200",
    "msg": "成功",
    "logKey": "89cf48ed",
    "ts": "1747362540390",
    "success": true
}
上一页
通知短信发送
下一页
营业执照OCR
Built with