常用接口清单和关键流程
公共请求格式
接口清单
用户管理
| 接口名称 | 接口地址 | 接口说明 |
|---|---|---|
| 创建未认证个人用户 | /open/psnUncertifiedCreate | 创建未认证的个人用户，以获得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在创建个人/企业后返回或通过【查询印章列表】接口查询。 |
| 企业实名认证地址（页面） | /open/corpCert/getUrl | 企业用户通过此接口进行企业认证操作，请求后返回认证页链接 |
印章管理
| 接口名称 | 接口地址 | 接口说明 |
|---|---|---|
| 查询印章列表 | /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 | 营销短信内容发送 |