常用接口清单和关键流程
公共请求格式
接口清单
用户管理
| 接口名称 | 接口地址 | 接口说明 |
|---|---|---|
| 创建未认证用户 | /open/uncertifiedCreate | 创建未认证的用户，传入的accountId作为合同接收方。未认证、已认证的用户都可以作为合同接收方，但未认证用户会在合同签署前要求实名认证 |
| 修改个人用户 | /open/psnUpdate | 修改个人用户的姓名、接收消息手机号。或传入认证流程号flowNo，将个人用户改为已认证 |
| 创建已认证个人用户 | /open/psnCreate | 通过flowNo或自行对用户信息进行验证后传值psnName+psnIDCardNum创建已认证个人用户 |
| 查询个人用户信息 | /open/psnGet | 【创建已认证个人用户】或【 创建未认证个人用户】后的用户，可通过此接口查询 |
| 创建企业 用户 | /open/corpCreate | 创建已认证企业用户，可通过flowNo进行创建，也可自行对企业信息进行验证后传入企业信息进行创建 |
| 查询企业用户信息 | /open/corpList | 【创建企业用户】后的企业可通过此接口进行查询 |
实名认证
| 接口名称 | 接口地址 | 接口说明 |
|---|---|---|
| 个人身份二要素核验 | /open/psnCert/2element | 个人[姓名]+[身份证] 二要素验证，验证结果flowNo可用于【创建个人用户】或【修改个人用户】并进行存证 |
| 个人运营商三要素核验 | /open/psnCert/3element | 通过印章ID查询印章详情，详情包含印章所授权静默签应用。印章ID在创建个人/企业后返回或通过【查询印章列表】接口查询。 |
| 个人人脸核验（H5适配） | /open/psnCert/faceUrl | [姓名]+[证件号]获取个人人脸页面进行人脸核身验证 |
| 个人人脸核验查询 | /open/psnCert/faceResult | 可通过此接口查询【个人人脸核验（H5适配）】结果 |
| 发送短信验证码 | /open/psnCert/psnSmsSend | 此接口用于校验手机号是否本人所有，发送短信接口。如果超时未收到短信验证码时，可以重新发送短信 |
| 校验短信验证码 | /open/psnCert/psnSmsCheck | 此接口用于【发送短信验证码】校验短信接口。若该验证码与最近短信发送时间超过15分钟以上，提示验证码过期 |
| 个人银行卡四要素核验 | /open/psnCert/bankCard4element | 个人[姓名]+[证件号码]+[手机号]+[银行卡号]四要素核验 |
| 个人实名认证地址（页面） | /open/psnCert/getUrl | 个人实名认证地址（页面）是由签盾提供的个人用户合规认证页面，目的为简化应用接入的流程。页面支持PC或H5访问（通过integrationConfig.clientType配置） |
| 企业四要素核验 | /open/corpCert/4element | [企业名称]+[统一社会信用]+[法定代表人姓名]+[法定代表人证件号]企业四要素核验 |
| 企业三要素核验 | /open/corpCert/3element | [企业名称]+[统一社会信用]+[法定代表人姓名]企业三要素核验 |
| 发起打款认证（正向打款） | /open/corpCert/remit2Corp | 企业对公正向打款验证，即签盾向认证企业进行打款。bankName参数查询查询打款银行信息 |
| 验证打款金额（正向打款） | /open/corpCert/verifyRemit2Corp | 校验【发起打款认证（正向打款）】金额是否准确。打款金额校验，只允许1次，一次校验失败后，需要重新发起打款，获取新的serviceId进行校验 |
| 查询打款进度（正向打款） | /open/corpCert/queryRemit2Corp | 调用【发起打款认证（正向打款）】成功后，可通过此接口查询打款或验证状态 |
| 企业经办人授权书认证-上传 | /open/corpCert/uploadCorpAuthorization | 二进制文件传输方式，经办人认证需要上传企业授权书 |
| 企业经办人授权书认证-查询 | /open/corpCert/queryCorpAuthorization | 查询【企业经办人授权书认证-上传】上传授权书的认证状态，通过开启授权书审批回调可在授权书审批完成后收到主动通知。 |
| 查询打款银行信息 | /open/remit/bank/list | 用于【发起打款认证（正向打款）】bankName字段传参 |
| 企业实名认证地址（页面） | /open/corpCert/getUrl | 企业用户通过此接口进行企业认证操作，请求后返回认证页链接 |
| 查询认证信息 | /open/certFlow/get | 根据认证时返回的flowNo查询认证流程信息 |
印章管理
| 接口名称 | 接口地址 | 接口说明 |
|---|---|---|
| 查询印章列表 | /open/sealList | 创建个人/企业用户后会自动创建对应印章。通过此接口可查询印章信息 |
| 查询印章详情 | /open/seal/detail | 通过印章ID查询印章详情，详情包含印章所授权静默签应用。印章ID在创建个人/企业后返回或通过【查询印章列表】接口查询。 |
| 印章静默签授权地址（页面） | /open/seal/autosign/auth/url | 通过此接口可对接入应用进行印章静默签授权。授权成功后在发起合同时传入对应参数就可以使用对应印章自动（静默）进行合同签署。 |
合同签署
| 接口名称 | 接口地址 | 接口说明 |
|---|---|---|
| 上传合同文件 | /open/file/upload | 非创建合同接口。此接口配合【通过上传文件发起合同】完成合同创建 |
| 基于模板生成合同文件 | /open/template/file/create | 非创建合同接口。通过模版管理上传模版，通过此接口生成合同文件，再配合【通过上传文件发起合同】完成合同创建 |
| 通过合同文件发起合同 | /open/contract/start | 通过合同文件发起合同接口 |
| 合同查询 | /open/contract/detail | 查询合同发起时间、签署状态、签署人等合同信息。发起后的合同可以通过此接口查询 |
| 查询签署方信息 | /open/contract/signer | 查询某签署人签署状态、签章位置、意愿认证配置等签署人详细信息 |
| 获取合同签署链接（页面） | /open/contract/sign/url | 通过此接口获取签署链接进行页面签署，若发起合同时未指定签署位置，则所有合同文件都必须进行落章 |
| 无感签署（申请开放） | /open/seal/autosign/auth/url | 签署人对发起后的合同直接进行签署。相较于普通签署方式，此接口无需进行授权与意愿认证（即用户无感知） |
| 下载合同文件及附件 | /open/contract/list/files | 签署过程中或签署完成后的合同文件，可以通过此接口将签署后的合同下载到本地进行合同存档。 |
开放接口
| 接口名称 | 接口地址 | 接口说明 |
|---|---|---|
| 短信通知/短信验证码 | /open/api/sms/send | 发送短信通知(注册、找回密码等发送验证码通知等) |
| 营销短信发送 | /open/api/sms/marketing/send | 营销短信内容发送 |
回调相关
主要流程
个人已认证用户创建
企业已认证用户创建
合同签署流程
修改于 2025-06-13 02:14:21