验证可验证凭证

最近更新时间:2024-03-12 01:53:22

我的收藏

1. 接口描述

接口请求域名: tdid.tencentcloudapi.com 。

验证已签名的可验证凭证

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:VerifyCredentials。
Version String 公共参数,本接口取值:2021-05-19。
Region String 公共参数,详见产品支持的 地域列表
VerifyType Integer 0:仅验证签名,1:验证签名和链上状态,2, 仅验证链上状态,默认为0, 3.验证DID和凭证状态以及签名,4. 验证历史凭证有效性
示例值:1
CredentialData String 凭证内容
示例值:{}
DAPId Integer DID应用id
示例值:1

3. 输出参数

参数名称 类型 描述
Result Boolean 是否验证成功
示例值:True
VerifyCode Integer 验证返回码
示例值:0
VerifyMessage String 验证结果信息
示例值:success
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 验证已签名的可验证凭证

验证凭证颁发者签发的可验证凭证

输入示例

POST / HTTP/1.1
Host: tdid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyCredentials
<公共请求参数>

{
    "DAPId": 1,
    "CredentialData": "{\"claim\":{\"age\":18,\"id\":\"did:tdid:w1:0x3b67623cbdaa9ccbfc8b7c346588c6bcbc6f5d63\",\"name\":\"zhang san\"},\"context\":\"https://github.com/WeBankFinTech/WeIdentity/blob/master/context/v1\",\"CPTId\":12000000,\"expirationDate\":1871212353,\"id\":\"42e180f9-e4fd-4cd0-93a6-1770f1f69c44\",\"issuanceDate\":1628063788,\"issuer\":\"did:tdid:w1:0x4c59267a10ed54857842674d0c76ab708c6275f5\",\"proof\":{\"created\":1628063788,\"creator\":\"did:tdid:w1:0x4c59267a10ed54857842674d0c76ab708c6275f5#keys-0\",\"salt\":{\"age\":\"KeMT6\",\"id\":\"qGZIB\",\"name\":\"8jMxZ\"},\"signatureValue\":\"mf9UEjhh2gIpxr2evRh+zbC2/1k4YyxKl4otn2v96wQfNrz3MKQ+nsc0P0H/hFNlh3F+8Z1gN9qSemWXyN8KAwA=\",\"type\":\"Secp256k1\"},\"type\":[\"VerifiableCredential\",\"original\"]}"
}

输出示例

{
    "Response": {
        "Result": true,
        "VerifyCode": 0,
        "VerifyMessage": "success",
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
Credential.CPTNotExisted 凭证模板不存在
Credential.CredentialExpired 凭证过期:<%ExtMsg%>
Credential.FailedCreatePresentation 创建凭证表达失败
Credential.GenerateCommitmentFailed 生成证明承诺失败
Credential.GenerateRangeProof 生成范围证明失败
Credential.HolderDidNotMatch 凭证持有人DID不匹配,请确认后重新操作:<%ExtMsg%>
Credential.InvalidCRDLId 无效的凭证ID,请确认后重新操作:<%ExtMsg%>
Credential.InvalidCRDLIssuer 无效的凭证颁发者,请确认后重新操作
Credential.InvalidClaim 无效的凭证声明,请确认声明格式:<%ExtMsg%>
Credential.InvalidDisclosurePolicy 无效的选择性披露策略,请确认后重新操作:<%ExtMsg%>
Credential.InvalidOperateClaim 无效的操作类型声明,请确认后重新操作:<%ExtMsg%>
Credential.InvalidParas 无效请求参数,请确认参数格式:<%ExtMsg%>
Credential.InvalidProofCommitment 无效的证明承诺
Credential.InvalidProofValue 无效的证明值,证明值要求是无符号整形
Credential.InvalidZeroProof 无效的零知识证明内容
Credential.IssuerDidNotMatch 凭证颁发者DID不匹配,请确认后重新操作:<%ExtMsg%>
Credential.NoIdInClaim 凭证声明缺少ID字段,请确认后重新操作
Credential.ProofValueNotExisted 证明数值不存在
Credential.VerifyCRDLFailed 凭证验证失败:<%ExtMsg%>
Credential.VerifyZeroProofFailed 零知识证明验证失败
DataBase.FailedOperation 数据库操作失败,请重新操作
DidFailedOperation.DidNotExisted DID标识不存在:<%ExtMsg%>
FailedOperation.InvalidAuth 用户接口鉴权失败
FailedOperation.InvalidParameterValue 无效的请求参数
FailedOperation.OperationException 操作失败。
InternalError.ServiceDisabled 服务已停止,请您检查当前是否有计费套餐包
InternalError.ServiceError 服务错误,请稍后重试,或联系客服
InternalError.ServicePanic 服务异常。
InternalError.UnknownError 服务错误,请稍后重试,或联系客服
InvalidParameterValue.IllegalValue 请求参数格式错误,请按照格式要求重新填写