电子合同API开发文档 v5

合同文件验证,验签

接口地址:https://api.1dq.com/v5/Contracts/validation.json

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

在线工具:API在线调试接口

接口描述:
合同文件验证,验签,验证合同有效性

请求参数

除去下列参数中,需要在header中添加公共参数,详见公共请求参数

参数名 是否必填 长度 类型 默认值 描述 示范
file_content - STRING -
合同文件base64字符串
xxxxx

请求示范

 POST https://api.1dq.com/v5/Contracts/validation.json
 {
    "file_content": "xxxxx"
}

返回结果

参数名 是否必填 长度 类型 默认值 描述 示范
code 1-10 long 业务状态码 200
msg 2-64 string 结果描述 请求成功
data - 结果集 -

----file_hash

- STRING 文件hash

----subject

- STRING 证书的拥有者

----status

- STRING 状态,1未修改,-1已被修改

----issuer

- STRING 证书颁发机构

----issuer_addr

- STRING 颁发者机构所在地

----version

- STRING 证书版本

----serialNumber

- STRING 证书唯一序列号

----validFrom_time_t

- STRING 证书有效期起始时间 2020-06-05 16:44:49

----validTo_time_t

- STRING 证书到期时间 2021-06-05 16:44:49

----signatureTypeSN

- STRING 加密方式 RSA-SHA256

----signatureTypeLN

- STRING 加密方式 sha256WithRSAEncryption

----is_1dq

- INT 是否我司印章 1 是, -1不是 1

----signed_time

- STRING 签署时间 2021-06-05 16:44:49

----reason

- STRING 签署原因

----seal_id

- STRING 印章id

----seal_data

- STRING 印章访问网址,半小时有限

----seal_class

- INT 印章类型,1个人印章,2企业印章,-2未知 1

----seal_page

- INT 印章位于第几页 1

----seal_is_place

- INT 是否骑缝章,1是,-1不是,-2 未知 1

成功示范

{
    "code": 200,
    "msg": "success",
    "data": [
        {
            "file_hash": "5db8148a8f66af24e53080a9fcbbec6b84037e1c211cb5e407eb971a17e77bbc",
            "subject": "上海加数信息科技有限公司",
            "status": 1,
            "issuer": "ShanXi Digital Certificate Authority (ShanXi Digital Certificate Authority)",
            "issuer_addr": "CN ShanXi",
            "version": 2,
            "serialNumber": "8515110***653014211741916324455",
            "validFrom_time_t": "2020-06-05 16:44:49",
            "validTo_time_t": "2021-06-05 16:44:49",
            "signatureTypeSN": "RSA-SHA256",
            "signatureTypeLN": "sha256WithRSAEncryption",
            "is_1dq": 1,
            "signed_time": "2020-06-13 00:45:44",
            "reason": "https:\/\/web.1dq.com\/#\/signed?words_id=1e17c4c8-accc-11ea-a63a-0242ac110004",
            "seal_id": "1e17c4c8-accc-11ea-a63a-0242ac110004",
            "seal_data": "https:\/\/tmp2.1dq.com\/seal\/1e17c4c8-accc-11ea-a63a-0242ac110004.png?x-oss-process=style%2Fwatermark&OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591986302&Signature=I4oafOeedut3U3BhrM4hBsInyV8%3D",
            "seal_class": 2,
            "seal_page": 1,
            "seal_is_place": -1
        },
        {
            "file_hash": "5db8148a8f66af24e53080a9fcbbec6b84037e1c211cb5e407eb971a17e77bbc",
            "subject": "上海xx信息科技有限公司",
            "status": 1,
            "issuer": "ShanXi Digital Certificate Authority (ShanXi Digital Certificate Authority)",
            "issuer_addr": "CN ShanXi",
            "version": 2,
            "serialNumber": "8515110202***238653014211741916324455",
            "validFrom_time_t": "2020-06-05 16:44:49",
            "validTo_time_t": "2021-06-05 16:44:49",
            "signatureTypeSN": "RSA-SHA256",
            "signatureTypeLN": "sha256WithRSAEncryption",
            "is_1dq": 1,
            "signed_time": "2020-06-13 00:45:44",
            "reason": "https:\/\/web.1dq.com\/#\/signed?words_id=1e17c4c8-accc-11ea-a63a-0242ac110004",
            "seal_id": "1e17c4c8-accc-11ea-a63a-0242ac110004",
            "seal_data": "https:\/\/tmp2.1dq.com\/seal\/1e17c4c8-accc-11ea-a63a-0242ac110004.png?x-oss-process=style%2Fwatermark&OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1591986302&Signature=I4oafOeedut3U3BhrM4hBsInyV8%3D",
            "seal_class": 2,
            "seal_page": 1,
            "seal_is_place": -1
        }
    ]
}

失败示范

{
    "code": 404,
    "msg": "文件保存失败",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码