E-Seal
home
Instances
version 1.0.0
Description
API description
This API is built to Expose REST API for OSCA.
Intended Use
This API has below functionality:
| No. | Resource | Method | Description |
|---|---|---|---|
| 1 | / | GET | Get the system's health |
| 2 | /internal-organizations | GET | Search Internal Organizations |
| 3 | /internal-organizations/{organizationCode}/seals | GET | Get Organization Seals |
| 4 | /external-organizations | GET | Search External Organizations |
| 5 | /files | POST | Upload File |
| 6 | /files/{fileKey}/word-positions | GET | Search PDF File Words Position |
| 7 | /signing-configuration-tasks | POST | Create Signing Configuration Task |
| 8 | /signing-configuration-tasks/{taskId} | GET | Get Signing Configuration Task Detail |
| 9 | /seals/{sealCode}/signers | GET | Get Signers of Seal |
| 10 | /external-organizations/{organizationCode}/members | GET | Get External Organization Members |
| 11 | /flows | POST | Create Signing Flow |
| 12 | /flows | GET | Get Signing Flow |
| 13 | /files/{fileKey}/content | GET | Download File |
Technical details
Main Route
| Interaction No | Action | API No | Mule API Endpoint |
|---|---|---|---|
| Get the system's health | 1 | / | |
| 4 | Search Internal Organizations | 2 | /internal-organizations |
| 10 | Get Organization Seals | 3 | /internal-organizations/{organizationCode}/seals |
| 18 | Search External Organizations | 4 | /external-organizations |
| 26 | Upload File | 5 | /files |
| 35 | Search PDF File Words Position | 6 | /files/{fileKey}/word-positions |
| 42 | Create Signing Configuration Task | 7 | /signing-configuration-tasks |
| 56 | Get Signing Configuration Task Detail | 8 | /signing-configuration-tasks/{taskId} |
| 63 | Get Signers of Seal | 9 | /seals/{sealCode}/signers |
| 68 | Get External Organization Members | 10 | /external-organizations/{organizationCode}/members |
| 73 | Create Signing Flow | 11 | /flows |
| 87 | Get Signing Flow | 12 | /flows |
| 91 | Download File | 13 | /files/{fileKey}/content |
Request Body Description:
| Resource | Method | Media Type |
|---|---|---|
| /files | POST | multipart/form-data |
| /signing-configuration-tasks | POST | application/json |
| /flows | POST | application/json |
Request Body Fields:
| Resource | Field Name | Type | Field Description |
|---|---|---|---|
| /files | file | binary | 选择上传的文件 |
| /signing-configuration-tasks | callbackUrl | string | 签署区配置页任务的信息回调URL |
| fileKeys | array | 文件fileKey列表 | |
| fileKeys.flieKey | string | 文件id | |
| signers | array | 待配置的签署方列表。不指定签署方时，支持用户自定义签署区名称。同一流程的签署方不允许重复 | |
| signers.userType | integer | 用户类型：1-内部，2-相对方 | |
| signers.userCode | string | 用户编码（本系统的唯一标识）。userType传值时，userCode与customAccountNo二选一必传；如果userCode、customAccountNo两者都有值，以userCode为准 | |
| signers.customAccountNo | string | 用户账号（客户系统的唯一标识）。userType传值时，userCode与customAccountNo二选一必传；如果userCode、customAccountNo两者都有值，以userCode为准 | |
| signers.departmentCode | string | 用户所属组织编号/兼职组织编号（本系统的唯一标识），需与organizationCode、customOrgNo匹配。不传默认取所属组织编号。如果departmentCode 、customDepartmentNo 两者都有值，以departmentCode 为准。 | |
| signers.customDepartmentNo | string | 用户所属组织编号/兼职组织账号（客户系统的唯一标识），需与organizationCode、customOrgNo匹配。不传默认取所属组织编号。如果departmentCode 、customDepartmentNo 两者都有值，以departmentCode 为准。 | |
| signers.organizationCode | string | 内部：用户授权企业编码（本系统的唯一标识）。不为空时，签署主体视为企业。外部：organizationCode值需和departmentCode 值保持一致如果organizationCode、customOrgNo两者都有值，以organizationCode为准。 | |
| signers.customOrgNo | string | 内部：内部：用户授权企业账号（客户系统的唯一标识）。不为空时，签署主体视为企业。外部：customOrgNo值需和customDepartmentNo 值一致如果organizationCode、customOrgNo两者都有值，以organizationCode为准。 | |
| signers.sealTypeCode | string | 指定印章类型，数据来源于印控中心，默认不指定如果为企业盖章，该参数生效；取值范围：内部签署主体企业授权给经办人的印章类型；外部来源于企业下发布的印章。如果sealTypeCode、sealId两者都有值，校验二者关系 | |
| signers.sealId | string | 按签署主体指定印章ID，数据来源于印控中心，默认不指定；相对方不支持指定印章id。如果sealTypeCode、sealId两者都有值，以sealId为准 | |
| signers.legalSignFlag | boolean | 是否添加法人签署区 | |
| /flows | subject | string | 流程主题 |
| businessNo | string | 第三方签署流程业务id | |
| businessTypeCode | string | 业务类型ID从统一门户-业务模板-配置-签署方式获取“签署业务类型编码） | |
| readComplete | integer | 是否强制阅读至最后一页：0否，1是；默认为0 | |
| advertisement | integer | 是否开启签约须知：0否，1是；默认为0 | |
| remark | string | 流程备注（长度200） | |
| signFlowExpireTime | string | 签署截止日期：超过签署截止日期后流程过期。 | |
| initiatorInfo | object | 发起方信息集合 | |
| initiatorInfo.userType | integer | 用户类型：1-内部，传0或不传均为内部。不支持外部发起签署，不支持传其他值 | |
| initiatorInfo.userCode | string | 用户编码（本系统的唯一标识）。如果userCode、customAccountNo两者都有值，以userCode为准 | |
| initiatorInfo.customAccountNo | string | 用户账号（客户系统的唯一标识）。如果userCode、customAccountNo两者都有值，以userCode为准 | |
| initiatorInfo.departmentCode | string | 用户所属组织编号/兼职组织编号（本系统的唯一标识），需与organizationCode、customOrgNo匹配。默认取所属组织编号。如果departmentCode 、customDepartmentNo 两者都有值，以departmentCode 为准。 | |
| initiatorInfo.customDepartmentNo | string | 用户所属组织编号/兼职组织账号（客户系统的唯一标识），需与organizationCode、customOrgNo匹配。默认取所属组织编号。如果departmentCode 、customDepartmentNo 两者都有值，以departmentCode 为准。 | |
| initiatorInfo.organizationCode | string | 用户所属企业编码（本系统的唯一标识）。如果organizationCode、customOrgNo两者都有值，以organizationCode为准。企业授权：企业印章管理-制作企业印章-发布后授权用印人。 | |
| initiatorInfo.customOrgNo | string | 用户所属企业账号（客户系统的唯一标识）。如果organizationCode、customOrgNo两者都有值，以organizationCode为准。企业授权：企业印章管理-制作企业印章-发布后授权用印人 | |
| CCInfos | array | 抄送方信息集合 | |
| CCInfos.userType | integer | 用户类型：1-内部，2-相对方 | |
| CCInfos.userCode | string | 用户编码（本系统的唯一标识）。如果userCode、customAccountNo两者都有值，以userCode为准 | |
| CCInfos.customAccountNo | string | 用户账号（客户系统的唯一标识）。如果userCode、customAccountNo两者都有值，以userCode为准 | |
| CCInfos.departmentCode | string | 用户所属组织编号/兼职组织编号（本系统的唯一标识），需与organizationCode、customOrgNo匹配。默认取所属组织编号。如果departmentCode 、customDepartmentNo 两者都有值，以departmentCode 为准。 | |
| CCInfos.customDepartmentNo | string | 用户所属组织编号/兼职组织账号（客户系统的唯一标识），需与organizationCode、customOrgNo匹配。默认取所属组织编号。如果departmentCode 、customDepartmentNo 两者都有值，以departmentCode 为准。 | |
| CCInfos.organizationCode | string | 用户所属企业编码（本系统的唯一标识）。如果organizationCode、customOrgNo两者都有值，以organizationCode为准。个人相对方organizationCode传 "GRXDF"（即：个人相对方首字母大写） | |
| CCInfos.customOrgNo | string | 用户所属企业账号（客户系统的唯一标识）。如果organizationCode、customOrgNo两者都有值，以organizationCode为准。 | |
| redirectUrl | string | 签署完成重定向地址 | |
| appRedirectInfo | array | 意愿认证完成、签署完成的APP跳转地址，支持传入不同的设备标识，实现跳转至对应设备下的APP地址。1、在app的webview.UA里注入appName（如ios、ios9、android、android12）2、签署页通过解析UA，匹配流程的appName信息：2.1、当appName识别到ios，跳转至ios对应的appSchema。2.2、当appName识别到ios9，跳转至ios9对应的appSchema。2.3、当appName识别到android，跳转至android对应的appSchema。2.4、当appName识别到android12，跳转至android12对应的appSchema。3、建议开发者在配置appSchema时，校验签署流程状态后再自行重定向至对应页面。 | |
| appRedirectInfo.appName | string | APP设备标识 | |
| appRedirectInfo.appSchema | string | APP跳转协议 | |
| signNotifyUrl | string | 签署成功回调 | |
| chargingType | integer | 付费方：1：发起方、2：相对方，默认1；需要开启“相对方付费”功能后，该参数生效。 | |
| signFiles | array | 流程文档信息集合 | |
| signFiles.fileKey | string | 签署文档fileKey | |
| signFiles.fileOrder | integer | 文档顺序,用于页面文档顺序显示 | |
| signFiles.qrFile | integer | 是否添加二维码，0否，1是；默认为0（值为1时二维码配置以接口传值为准） | |
| signFiles.qrFileInfos | object | 二维码配置集合 | |
| signFiles.qrFileInfos.qrWidth | integer | 二维码宽度：只支持正方形二维码，宽度、长度共用一个参数，默认96 ；支持96～149（PX）之间整数 | |
| signFiles.qrFileInfos.qrView | integer | 二维码查看权限：0-全部 1-流程参与人 ，默认为1 | |
| signFiles.qrFileInfos.watermarkPage | integer | 水印页数：1-首页 2-末页 3-所有页 默认为3 | |
| signFiles.qrFileInfos.watermarkPosition | integer | 水印位置：1-左上角 2-右上角 3-左下角 4-右下角 默认为1 | |
| signFiles.qrFileInfos.qrPosX | integer | x偏移量：支持0-99999之间整数；默认为0 | |
| signFiles.qrFileInfos.qrPosY | integer | y偏移量：支持0-99999之间整数；默认为0 | |
| attachments | array | 附件信息集合 | |
| attachments.fileKey | string | 附件fileKey | |
| attachments.fileOrder | integer | 附件顺序,用于页面文档顺序显示 | |
| signerInfos | array | 签署方信息集合 | |
| signerInfos.userType | integer | 用户类型：1-内部，2-相对方 | |
| signerInfos.userCode | string | 用户编码（本系统的唯一标识）。如果userCode、customAccountNo两者都有值，以userCode为准 | |
| signerInfos.customAccountNo | string | 用户账号（客户系统的唯一标识）。如果userCode、customAccountNo两者都有值，以userCode为准 | |
| signerInfos.departmentCode | string | 用户所属组织编号/兼职组织编号，需与organizationCode匹配。默认取所属组织编号。不校验与企业的隶属关系，需校验与用户的隶属关系。 | |
| signerInfos.customDepartmentNo | string | 【0725】用户所属组织账号/兼职组织账号（客户系统的唯一标识），需与userCode、customAccountNo匹配。默认取所属组织编号。如果departmentCode 、customDepartmentNo 两者都有值，以departmentCode 为准。不校验与企业的隶属关系，需校验与用户的隶属关系。 | |
| signerInfos.organizationCode | string | 企业编码（本系统的唯一标识）。不为空时，签署主体视为企业。如果organizationCode、customOrgNo两者都有值，以organizationCode为准。不校验与用户、部门的隶属关系。 | |
| signerInfos.customOrgNo | string | 企业账号（客户系统的唯一标识）。不为空时，签署主体视为企业。如果organizationCode、customOrgNo两者都有值，以organizationCode为准。不校验与用户、部门的隶属关系。 | |
| signerInfos.autoSign | integer | 是否静默签署：0否，1是；默认为0；只针对内部用户，开启静默签署后会自动使用用户的印章和证书完成签署 | |
| signerInfos.legalSignFlag | integer | 是否添加法人签署：0否，1是；默认为0 | |
| signerInfos.signNode | integer | 签署方节点顺序，最小为1。（节点顺序） | |
| signerInfos.signMode | integer | 签署顺序编排模式：0-顺序签，1-无序签，2-或签，默认0 | |
| signerInfos.sealTypeCode | string | 指定印章类型，内部印章数据来源于印控中心，默认不指定；如果为机构盖章，该参数生效外部印章数据固定以下类型：PUBLIC ：公章 CONTRACT：合同专用章 FINANCE：财务专用章 COMMON：其他 | |
| sealInfos | array | 签署任务信息：指定文档进行签署，未指定的文档将作为只读 | |
| sealInfos.fileKey | string | 签署文档fileKey | |
| sealInfos.signConfigs | array | 签署位置信息;必须指定签署位置信息才可以签署 | |
| sealInfos.signConfigs.signatureType | string | 指定签署印章类型：PERSON-SEAL-个人印章、COMMON-SEAL-企业授权印章、LEGAL-PERSON-SEAL-法人章 | |
| sealInfos.signConfigs.handEnable | boolean | 是否强制手绘签名 当signatureType=PERSON-SEAL时，生效 | |
| sealInfos.signConfigs.sealId | string | 印章id，需要校验用印权限；如果sealTypeCode、signatureType有值，需同时校验印章类型是否一致。 | |
| sealInfos.signConfigs.width | float | 签名域宽度，为空则取印章大小。单位：px | |
| sealInfos.signConfigs.signType | string | 签署类型: COMMON-SIGN : 普通（包含单页签、多页签)， EDGE-SIGN:骑缝，KEYWORD-SIGN:关键字，默认COMMON-SIGN | |
| sealInfos.signConfigs.edgeScope | integer | 骑缝章签署范围：0-指定页（默认全选），1-奇数页，2-偶数页，默认0 | |
| sealInfos.signConfigs.keywordInfo | object | 关键字定位信息集合 | |
| sealInfos.signConfigs.keywordInfo.keyword | string | 关键字（以关键字形成的矩形区域的左下角为参考点进行定位） | |
| sealInfos.signConfigs.keywordInfo.keywordIndex | string | 指定签署某个位置关键字,受页码范围控制。-1为最后一个,超过关键字总数选中最后一个 | |
| sealInfos.signConfigs.keywordInfo.offsetPosX | string | 关键字横坐标偏移量 | |
| sealInfos.signConfigs.keywordInfo.offsetPosY | string | 关键字纵坐标偏移量 | |
| sealInfos.signConfigs.pageNo | string | 签署页码;连续页码用'-'连接，单独页码用','连接 | |
| sealInfos.signConfigs.posX | string | x轴偏移量;骑缝签无视该参数 | |
| sealInfos.signConfigs.posY | string | y轴偏移量 | |
| sealInfos.signConfigs.addSignDate | boolean | 是否添加签署时间 | |
| sealInfos.signConfigs.sealSignDatePositionInfo | object | 签章日期信息 | |
| sealInfos.signConfigs.sealSignDatePositionInfo.sealSignDateFormat | integer | 签章日期时间格式，1：yyyy-MM-dd、2：yyyy年mm月dd日、3：yyyy/MM/dd，默认1 | |
| sealInfos.signConfigs.sealSignDatePositionInfo.fontSize | string | 签署时间字体大小，最小为5，最大为72，默认16 | |
| sealInfos.signConfigs.sealSignDatePositionInfo.posX | string | x坐标 | |
| sealInfos.signConfigs.sealSignDatePositionInfo.posY | string | y坐标 |
Response Body Fields:
| Resource | Field Name | Type | Field Description |
|---|---|---|---|
| /internal-organizations | internalOrganizations | array | 内部组织列表 |
| customOrgNo | string | 组织账号（客户系统的组织唯一标识） | |
| legalRepAccountNo | string | 法定代表人账号（客户系统的唯一标识） | |
| legalRepName | string | 法定代表人姓名 | |
| legalRepUserCode | string | 法定代表人编码（本系统的唯一标识） | |
| licenseNo | string | 证件号码 | |
| licenseType | string | 证件类型，默认CREDIT_CODE;CREDIT_CODE统一社会信用代码;REGIST_NUMBER 工商注册号 | |
| name | string | 组织名称 | |
| organizationCode | string | 组织编码（本系统的组织唯一标识） | |
| organizationType | string | 分类，DEPARTMENT:部门;COMPANY:公司 | |
| parentCode | string | 上级组织编码（本系统的组织唯一标识） | |
| parentName | string | 上级组织名称 | |
| parentOrgNo | string | 上级组织账号（客户系统的组织唯一标识） | |
| /internal-organizations/{organizationCode}/seals | seals | array | 印章列表 |
| sealCode | string | 印章编码 | |
| sealPattern | string | 印章形态（1-电子章 2-物理章） | |
| sealName | string | 印章名称 | |
| defaultSeal | string | 是否为默认印章（0 不是 1是） | |
| sealTypeName | string | 印章类型名称 | |
| sealTypeCode | string | 印章类型编码 | |
| organizationName | string | 印章所属机构名称 | |
| organizationCode | string | 印章所属机构code | |
| sealStructure | string | 印章体结构：1-IMAGE 2-ASN_1 印章形态为电子印章时有值，物理印章时无值 | |
| sealId | string | 印章Id获取.jpg .png格式图片调取接口“获取单个文件”a. 印章形态为物理印章调取接口“获取单个文件”业务类型为印章管理-企业物理印章 传值： YZGL-QYWLYZ b.印章形态为电子印章调取接口“获取单个文件”业务类型为印章管理-企业电子印章 传值： YZGL-QYDZYZ 印章形态为电子印章时有值，物理印章时无值 | |
| sealHeight | number | 印章高度，单位：毫米 | |
| sealWidth | number | 印章宽度，单位：毫米 | |
| sealColour | string | 印章颜色（1红色 2蓝色 3黑色 ） | |
| sealSource | string | 制章方式(1自定义印章 2使用印章模板) | |
| base64img | string | 印章图片base64 图片 | |
| downloadUrl | string | 印章下载地址 | |
| sealExplain | string | 印章说明 | |
| sealStatus | string | 印章状态（g已发布） | |
| pagination | object | 分页信息 | |
| pageNo | integer | 当前页 | |
| pageSize | integer | 单页数量 | |
| totalRecords | integer | 印章列表数量 | |
| totalPages | integer | 总页数 | |
| /external-organizations | externalOrganizations | array | 外部组织列表 |
| customOrgNo | string | 组织账号（客户系统的组织唯一标识） | |
| legalRepAccountNo | string | 法定代表人账号（客户系统的唯一标识） | |
| legalRepName | string | 法定代表人姓名 | |
| legalRepUserCode | string | 法定代表人编码（本系统的唯一标识） | |
| licenseNo | string | 证件号码 | |
| licenseType | string | 证件类型，默认CREDIT_CODE;CREDIT_CODE---统一社会信用代码;REGIST_NUMBER---工商注册号 | |
| name | string | 组织名称 | |
| organizationCode | string | 组织编码（本系统的组织唯一标识） | |
| /files | file | object | 上传文件 |
| fileKey | string | 文件fileKey | |
| /files/{fileKey}/word-positions | file | object | 文件id |
| fileKey | string | 文件id | |
| keywords | array | 关键字位置列表 | |
| keyword | string | 关键字 | |
| positionList | array | 位置列表 | |
| posX | number | X轴偏移量 | |
| posY | number | Y轴偏移量 | |
| posNo | integer | 关键字页码 | |
| /signing-configuration-tasks | signingConfigurationTask | object | 签署配置任务详情 |
| filePreTaskId | string | 签署区配置页任务id | |
| filePreURL | string | 签署区配置页任务url | |
| /signing-configuration-tasks/{taskId} | signingConfigurationTask | object | 签署配置任务详情 |
| taskId | string | 签署配置任务id | |
| filePreURL | string | 签署区配置页URL | |
| filePreTaskInfos | array | 签署区配置信息集合 | |
| userType | string | 用户类型：1-内部，2-相对方 | |
| userCode | string | 用户编码（本系统的唯一标识）。如果userCode、customAccountNo两者都有值，以userCode为准 | |
| customAccountNo | string | 用户账号（客户系统的唯一标识）。如果userCode、customAccountNo两者都有值，以userCode为准 | |
| departmentCode | string | 用户所属组织编号/兼职组织编号（本系统的唯一标识），需与organizationCode、customOrgNo匹配。默认取所属组织编号。如果departmentCode、customDepartmentNo 两者都有值，以departmentCode 为准。 | |
| customDepartmentNo | string | 用户所属组织编号/兼职组织账号（客户系统的唯一标识），需与organizationCode、customOrgNo匹配。默认取所属组织编号。如果departmentCode、customDepartmentNo 两者都有值，以departmentCode 为准。 | |
| organizationCode | string | 用户授权企业编码（本系统的唯一标识）。不为空时，签署主体视为企业。如果organizationCode、customOrgNo两者都有值，以organizationCode为准。 | |
| customOrgNo | string | 用户授权企业账号（客户系统的唯一标识）。不为空时，签署主体视为企业。如果organizationCode、customOrgNo两者都有值，以organizationCode为准。 | |
| legalSignFlag | boolean | 是否添加法人签署：0否，1是；默认为0 | |
| sealTypeCode | string | 指定印章类型。印章类型为企业授权经办人的印章类型 | |
| sealInfos | array | 签署任务信息：指定文档进行签署，未指定的文档将作为只读 | |
| fileKey | string | 签署文档fileKey | |
| signConfigs | array | 签署位置信息 | |
| signPosName | string | 签署区名称 | |
| signatureType | string | 指定签署印章类型：PERSON-SEAL-个人印章、COMMON-SEAL-企业授权印章、LEGAL-PERSON-SEAL-法人章 | |
| signType | string | 签署类型: COMMON-SIGN : 普通（包含单页签、多页签)， EDGE-SIGN:骑缝，KEYWORD-SIGN:关键字，默认COMMON-SIGN | |
| sealId | string | 指定印章id;signatureTpye值为PERSON-SEAL：印章id为个人发布的印章id;signatureType值为COMMON-SEAL：印章id为企业授权经办人的印章id;signatureType值为LEGAL-PERSON-SEAL：印章id为企业法人发布的印章id | |
| edgeScope | string | 骑缝章签署范围：0-指定页（默认全选），1-奇数页，2-偶数页，默认0 | |
| keywordInfo | object | 关键字定位信息集合 | |
| offsetPosX | number | 关键字横坐标偏移量 | |
| offsetPosY | number | 关键字纵坐标偏移量 | |
| pageNo | string | 签署页码：连续页码用'-'连接，单独页码用','连接 | |
| posX | string | x轴偏移量;骑缝签无视该参数 | |
| posY | string | y轴偏移量 | |
| addSignDate | boolean | 是否添加签署时间 | |
| sealSignDatePositionInfo | object | 签章日期信息 | |
| sealSignDateFormat | integer | 签署日期格式：1：YYYY-MM-DD、2：YYYY年MM月DD日、3：YYYY/MM/DD，默认为1 | |
| fontSize | number | 签署时间字体大小，最小为5，最大为72，默认16 | |
| posX | string | x坐标 | |
| posY | string | y坐标 | |
| /seals/{sealCode}/signers | seal | object | 印章 |
| sealCode | string | 印章编码（己发布的电子印章编码） | |
| signers | array | 用印人列表 | |
| userCode | string | 用印人编码 | |
| customAccountNo | string | 用印人账号 | |
| userName | string | 用印人姓名 | |
| organizationCode | string | 用印人组织编码 | |
| customOrgNo | string | 用印人组织账号 | |
| organizationName | string | 用印人组织名称 | |
| pagination | object | 分页信息 | |
| pageNo | integer | 当前页 | |
| pageSize | integer | 单页数量 | |
| totalRecords | integer | 用印人列表数量 | |
| totalPages | integer | 总页数 | |
| /external-organizations/{organizationCode}/members | externalOrganization | object | 外部组织 |
| organizationCode | string | 组织编码（本系统的组织唯一标识） | |
| members | array | 用户列表 | |
| userCode | string | 用户编码（本系统的唯一标识） | |
| customAccountNo | string | 用户账号（客户系统的唯一标识） | |
| name | string | 用户姓名 | |
| mobile | number | 手机号 | |
| string | 邮箱 | ||
| pagination | object | 分页信息 | |
| pageNo | integer | 当前页 | |
| pageSize | integer | 单页数量 | |
| totalRecords | integer | 用户列表数量 | |
| totalPages | integer | 总页数 | |
| /flows（Post） | signingFlow | object | 签署流程信息 |
| signFlow.signFlowId | string | 签署流程id | |
| signFlow.businessNo | string | 第三方签署流程业务id | |
| signFlow.signFlowStatus | integer | 流程状态：0-草稿，1-签署中，2-已完成，3-已过期，4-已拒签，5-已作废，6-作废中 | |
| signFlow.signFiles | array | 文件信息 | |
| signFlow.signFiles.fileKey | string | 文件fileKey | |
| signFlow.signFiles.fileOrder | integer | 文档顺序,用于页面文档顺序显示 | |
| signFlow.attachments | array | 附件信息集合 | |
| signFlow.attachments.fileKey | string | 附件fileKey | |
| signFlow.attachments.fileOrder | integer | 附件顺序,用于页面文档顺序显示 | |
| /flows (Get) | signingFlow | object | 签署流程信息 |
| signFlowId | string | 签署流程id | |
| businessNo | string | 第三方业务码（长度50） | |
| signFlowStatus | integer | 流程状态：0-草稿，1-签署中，2-已完成，3-已过期，4-已拒签，5-已作废，6-作废中 | |
| signFlowEndTime | string | 签署结束时间 | |
| signFlowCreateTime | string | 签署开始时间 | |
| subject | string | 流程主题 | |
| businessTypeCode | string | 业务类型编号 | |
| remark | string | 流程备注（长度200） | |
| signNotifyUrl | string | 签署回调通知地址（长度500） | |
| redirectUrl | string | 签署完成重定向地址（长度500） | |
| signFlowExpireTime | string | 签署截止日期：超过签署有效期后流程过期 | |
| signFileFormat | string | 签署文件类型 pdf/ofd | |
| initiatorInfo | object | 发起方信息 | |
| userCode | string | 发起方用户唯一标识 | |
| userType | integer | 发起方用户类型：1-内部，2-相对方 | |
| userName | object | 发起方姓名 | |
| organizationCode | object | 发起方所属组织编号/兼职组织编号，需与organizationCode匹配。默认取所属组织编号。 | |
| CCInfos | array | 抄送方信息集合 | |
| userCode | string | 抄送方用户唯一标识 | |
| userType | integer | 抄送方用户类型：1-内部，2-相对方 | |
| userName | string | 抄送方用户名 | |
| departmentCode | string | 抄送方所属组织编号/兼职组织编号，需与organizationCode匹配。默认取所属组织编号。 | |
| organizationCode | string | 抄送方所属机构唯一标识 | |
| signFiles | array | 流程文档信息集合 | |
| fileKey | string | 签署文档fileKey | |
| fileOrder | integer | 文档顺序,用于页面文档顺序显示 | |
| signedFileKey | string | 签署后文档fileKey，仅当流程为“2-已完成”状态时返回。 | |
| attachments | array | 附件信息集合 | |
| fileKey | string | 附件fileKey | |
| fileOrder | integer | 文档顺序,用于页面文档顺序显示 | |
| signerInfos | array | 签署方信息 | |
| userCode | string | 签署方用户唯一标识 | |
| userName | string | 签署方用户名 | |
| userType | integer | 签署方用户类型：1-内部，2-相对方 | |
| approvalFlowIds | array | 签署印章审批ID | |
| departmentCode | string | 签署方所属组织编号/兼职组织编号，需与organizationCode匹配。默认取所属组织编号。 | |
| organizationCode | string | 签署方代理的部门唯一标识 | |
| signMode | integer | 签署顺序编排模式：0-顺序签，1-无序签，2-或签，默认0 | |
| signNode | integer | 签署方节点顺序，最小为1。 | |
| signerStatus | integer | 签署方状态：0-待签署，1-签署中，2-已签署，3-已拒签，4-无需签署 | |
| signDate | string | 签署时间 | |
| signFileDetails | array | 签署文档列表 | |
| fileKey | string | 签署文档fileKey | |
| fileOrder | integer | 文档顺序,用于页面文档顺序显示 | |
| /files/{fileKey}/content | N/A | binary | 下载文件 |
Release Notes
| Version | Status | Release Date | End-of-Life Date |
|---|---|---|---|
| v1.0.0 | Released | 18-OCT-2023 | NA |