Method: vdc.getProofingStatus

用于检索身份验证当前状态的端点。

HTTP 请求

POST https://example.issuer.com/api/v1/vdc/getProofingStatus

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string
}
字段
requestMetadata

object (RequestMetadata)

必需。有关请求的元数据，所有请求中都需要提供。
deviceReferenceId

string

必需。与设备对应的 ID 以及与设备关联的身份密钥。此 ID 不是设备 ID，也就是说，如果用户在同一设备上拥有两个不同的凭据，则此 ID 会因凭据而异。

此 ID 会在所有请求中提供，可用于关联请求。
proofingId

string

必需。一种不透明的标识符，用于表示特定设备的特定证据包的验证。

例如：UUID

响应正文

包含校对当前状态的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingStatus": {
    object (ProofingStatus)
  }
}
字段
responseMetadata

object (ResponseMetadata)

必需。有关响应的元数据，所有响应中都需要包含此元数据。
proofingStatus

object (ProofingStatus)

必需。校样的当前状态。

ProofingStatus

一个对象，用于表示校样可以具有的不同状态。

JSON 表示法 
{

  // Union field status can be only one of the following:
  "pending": {
    object (Pending)
  },
  "accepted": {
    object (Accepted)
  },
  "rejected": {
    object (Rejected)
  },
  "challenged": {
    object (Challenged)
  },
  "canceled": {
    object (Canceled)
  },
  "revoked": {
    object (Revoked)
  },
  "expired": {
    object (Expired)
  }
  // End of list of possible types for union field status.
}
字段
联合字段 status。必需。一个 oneof，包含校样可能具有的不同状态。status 只能是下列其中一项：
pending

object (Pending)

待处理状态，表示发卡机构尚未做出决定。
accepted

object (Accepted)

一种“已接受”状态，表示签发方已接受身份验证。
rejected

object (Rejected)

拒绝状态，表示签发方已拒绝身份验证。
challenged

object (Challenged)

一种受质疑状态，表示签发方希望用户先完成验证，然后再对身份验证做出决定。
canceled

object (Canceled)

一种取消状态，表示用户已取消身份验证。
revoked

object (Revoked)

撤消状态，表示发卡机构已撤消身份验证。
expired

object (Expired)

过期状态，表示在签发方设置的截止日期之前，验证未做出决定（可能是由于未完成质询）。

待处理

此类型没有字段。

表示待处理状态的对象。此消息目前故意为空。未来可能会添加新字段。

已接受

此类型没有字段。

表示已接受的验证状态的对象。

已拒绝

表示被拒绝的校样状态的对象。

JSON 表示法 
{
  "primaryRejection": {
    object (Rejection)
  },
  "additionalRejections": [
    {
      object (Rejection)
    }
  ]
}
字段
primaryRejection

object (Rejection)

相应校样被拒的主要原因。
additionalRejections[]

object (Rejection)

如果存在，则指明验证被拒的其他原因。

遭拒

一个对象，包含有关导致校样处于“遭拒”状态的特定拒绝原因的详细信息。

JSON 表示法 
{
  "rejectionDescription": string,
  "issuerRejectionIdentifier": string,

  // Union field reason can be only one of the following:
  "evidenceMismatch": {
    object (EvidenceMismatch)
  },
  "evidenceIncomplete": {
    object (EvidenceIncomplete)
  },
  "lowRiskScore": {
    object (LowRiskScore)
  },
  "recordNotFound": {
    object (RecordNotFound)
  },
  "recordInvalid": {
    object (RecordInvalid)
  },
  "maxProvisioningsReached": {
    object (MaxProvisioningsReached)
  },
  "riskCheckFailure": {
    object (RiskCheckFailure)
  },
  "livenessCheckFailure": {
    object (LivenessCheckFailure)
  }
  // End of list of possible types for union field reason.
}
字段
rejectionDescription

string

供支持代表调试的拒绝说明。请注意，此信息绝不会向用户显示。它可以包含用于调试的说明性非敏感文本。

警告：请勿在此消息中包含任何个人身份信息。
issuerRejectionIdentifier

string

此标识符特定于发卡机构，由发卡机构生成。它仅用于调试目的，以识别拒绝。这是发卡机构识别相应拒绝的标识符。
联合字段 reason。必需。一个 oneof，用于表示校样被拒的各种原因。reason 只能是下列其中一项：
evidenceMismatch

object (EvidenceMismatch)

表示由于证据不匹配，身份验证被拒。

使用示例：- 应用拍摄的自拍照与签发方系统中的图片不一致。- 应用捕获文档图片与签发方系统中的图片不一致。
evidenceIncomplete

object (EvidenceIncomplete)

表示因证据不完整而拒绝了校样。

使用示例：- 签发者未收到所有必需的证明。
lowRiskScore
(deprecated)

object (LowRiskScore)

（已弃用：请相应地使用 riskCheckFailure 或 livenessCheckFailure）

表示由于风险得分较低，校样被拒绝。

使用示例：- 钱包提供的风险评分较低。- 发卡机构已锁定此用户，原因是其多次尝试失败。
recordNotFound

object (RecordNotFound)

表示因发证机构的系统中不存在相应记录而拒绝了验证。

使用示例：- 签发机构的系统中未找到相应记录。- 针对特定记录选择不参与。
recordInvalid

object (RecordInvalid)

表示由于签发方系统中的记录处于无效状态，验证被拒绝。

使用示例：- 记录处于已取消状态。- 记录已过期。
maxProvisioningsReached

object (MaxProvisioningsReached)

表示校对被拒绝，原因是已将文档配置到允许的最大设备数量。
riskCheckFailure

object (RiskCheckFailure)

表示由于风险评分检查失败，身份验证被拒。

使用示例：- 钱包提供的风险得分较高，表示欺诈风险较高。- 发卡机构评估认为该请求存在很高的欺诈风险。
livenessCheckFailure

object (LivenessCheckFailure)

表示由于活体检测失败，身份验证被拒。

使用示例：- 钱包提供的活体检测得分较低。

EvidenceMismatch

一个对象，用于指示因证据不匹配而被拒绝。

JSON 表示法 
{
  "evidenceType": string
}
字段
evidenceType

string

不匹配的证据的说明。仅用于调试目的。

EvidenceIncomplete

一个对象，用于指示证据不完整拒绝。

JSON 表示法 
{
  "evidenceType": string
}
字段
evidenceType

string

不完整证据的说明。仅用于调试目的。

LowRiskScore

此类型没有字段。

表示低风险得分拒绝的对象。此消息目前故意为空。未来可能会添加新字段。

RecordNotFound

此类型没有字段。

一个对象，用于指示“未找到记录”拒绝。此消息目前故意为空。未来可能会添加新字段。

RecordInvalid

一个对象，用于指示无效的记录拒绝。

JSON 表示法 
{
  "invalidityReason": string
}
字段
invalidityReason

string

说明记录无效的原因。

MaxProvisioningsReached

一个对象，用于指示已达到最大配置数而导致的拒绝。

JSON 表示法 
{
  "maxNumberOfProvisioningsAllowed": integer
}
字段
maxNumberOfProvisioningsAllowed

integer

发卡机构的政策允许的最大配置次数。

RiskCheckFailure

此类型没有字段。

一个对象，用于指示风险检查失败拒绝。此消息目前故意为空。未来可能会添加新字段。

LivenessCheckFailure

此类型没有字段。

一个对象，用于指示活跃性检查失败拒绝。此消息目前故意为空。未来可能会添加新字段。

挑战

表示存在质疑的身份验证状态的对象。

JSON 表示法 
{
  "challengeDescription": string,

  // Union field challenge can be only one of the following:
  "physicalLocationVisit": {
    object (PhysicalLocationVisit)
  },
  "issuerUrlVisit": {
    object (IssuerUrlVisit)
  },
  "additionalTimeRequired": {
    object (AdditionalTimeRequired)
  }
  // End of list of possible types for union field challenge.
}
字段
challengeDescription

string

必需。支持人员调试时遇到的问题说明。请注意，此信息绝不会向用户显示。它可以包含用于调试的说明性非敏感文本。

警告：请勿在此消息中包含任何个人身份信息。
联合字段 challenge。必需。用户可能需要完成的各种验证之间的 oneof。challenge 只能是下列其中一项：
physicalLocationVisit

object (PhysicalLocationVisit)

一种验证方式，用户必须前往实体地点（例如发卡机构的办公室）才能完成验证。
issuerUrlVisit

object (IssuerUrlVisit)

一种挑战选项，用户必须访问发卡机构提供的网址，并在该网址上完成挑战。
additionalTimeRequired

object (AdditionalTimeRequired)

一种挑战选项，表示需要更多时间来审核此校样。

PhysicalLocationVisit

此类型没有字段。

一个对象，表示用户必须前往实际地点（例如发卡机构的办公室）才能完成的验证选项。此挑战不在 Google 的支持范围内。出于安全考虑，如果发卡机构支持此验证类型，则必须在初始配置期间向 Google 提供营业地点详细信息。

IssuerUrlVisit

此类型没有字段。

一个对象，表示用户必须访问签发者提供的网址并在该网址上完成验证的验证选项。此挑战不在 Google 的支持范围内。出于安全考虑，如果发卡机构支持此验证类型，则必须在新手入门期间向 Google 提供相应网址。

AdditionalTimeRequired

一个对象，表示需要额外时间来审核证明的质疑选项。您可以选择提供预计完成时间。

JSON 表示法 
{
  "estimatedCompletion": string
}
字段
estimatedCompletion

string (int64 format)

校对完成的预计时间。如果存在，则为审核完成的预计时间。格式为时间戳，时间戳以自 Unix 纪元以来的毫秒数表示。

已取消

此类型没有字段。

表示已取消校样状态的对象。此消息目前故意为空。未来可能会添加新字段。

已撤消

此类型没有字段。

表示已撤消身份验证状态的对象。此消息目前故意为空。未来可能会添加新字段。

已过期

此类型没有字段。

表示已过期的身份验证状态的对象。此消息目前故意为空。未来可能会添加新字段。