核验签署文件上链信息

更新时间:2021/07/20 13:43:31

接口描述

对接方可通过查询区块链上链信息接口获取的docHashantTxHash进行核验上链的信息是否一致,数据是否被篡改。

注意:对接方也可通过蚂蚁区块链核验中心进行上链信息核验,详细核验步骤【请点击】。

接口名称

/v1/checkAntfinNotary

请求域名

开发环境

请求域名

公网IP

端口

沙箱环境

https://smlopenapi.esign.cn

114.55.17.44

443

正式环境

https://openapi.esign.cn

118.31.181.75

443

请求方式

POST

请求头

方式二:OAuth2.0鉴权(不推荐)

当安全接入选择OAuth2.0鉴权方式详见OAuth2.0鉴权方式调用接口说明

方式一:请求签名鉴权方式(优先推荐)

详见请求签名鉴权方式调用接口说明

请求签名鉴权方式所需请求头格式参数如下:

参数名称

类型

必选

参数说明

示例值

X-Tsign-Open-App-Id

string

项目ID


X-Tsign-Dns-App-Id

String

项目ID。在微信小程序中对接,该参数必传;其他场景无需添加该参数


Content-Type

string

application/json;charset=UTF-8


X-Tsign-Open-Ca-Timestamp

string

API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击


Accept

string

建议统一填写 */*


X-Tsign-Open-Ca-Signature

string

签名字符串


Content-MD5

string

当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。


X-Tsign-Open-Auth-Mode

string

选择请求方式进行鉴权,固定值,Signature


请求参数

参数名称

类型

必选

参数类型

参数说明

示例值

docHash

string

body

签署文件的哈希值。


antTxHash

string

body

蚂蚁区块链统一证据编号。


公共响应参数

参数名称

类型

必选

参数说明

示例值

code

int

业务码,0表示成功,非0表示失败


message

string

业务码信息


data

object

业务数据


响应参数

参数名称

类型

必选

参数说明

docHash

string

签署文件的哈希值

blockHeight

long

区块高度,当前存储区块在区块链的位置

errorCode

long

错误码。

0-核验成功(errorMessage为null

2302-核验数据比对不一致(Check failed, inconsistent content

2303-无核验权限(Permission error

2304-非法的Base64数据(Invalid Base64 Data

3001-不存在的存证类型(Notary Type Error

3008-未找到指定存证(Notary Not Found

errorMessage

string

错误信息。

0-核验成功(errorMessage为null

2302-核验数据比对不一致(Check failed, inconsistent content

2303-无核验权限(Permission error

2304-非法的Base64数据(Invalid Base64 Data

3001-不存在的存证类型(Notary Type Error

3008-未找到指定存证(Notary Not Found

notaryTime

date

蚂蚁区块链上链存证时间

notaryType

string

存证类型。固定值,TextNotary(文本存证

phase

string

存证阶段。默认为空

result

boolean

核验结果。

true-核验成功

false-核验失败

antTransactionId

string

当前流程的签署文件上链事务的唯一标识。

antTxHash

string

蚂蚁区块链统一证据编号。

请求示例  

POST请求地址示例:

https://openapi.esign.cn/v1/checkAntfinNotary

body体内JSON数据示例:

{
    "docHash": "e3d635871f5f2deb2******0f0a90a58a039ee3",
    "antTxHash": "d8f5caf9910ad812f0******bcb798ff3635eb3"
}

响应示例

{
    "data": {
        "docHash": "e3d635871f5f2*****568358a9fe40f0a90a58a039ee3",
        "blockHeight": 2905994,
        "errorCode": 0,
        "errorMessage": null,
        "notaryTime": 1592558320677,
        "notaryType": "TextNotary",
        "phase": null,
        "result": true,
        "antTransactionId": "fb0b621f-141b-4254-a411-28b8732adf8a",
        "antTxHash": "d8f5caf99*****7b2904bcb798ff3635eb3"
    },
    "message": "成功",
    "code": 0
}

错误码

错误码

错误描述

解决方案