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，可用於建立要求之間的關聯。
proofingId

string

不透明的 ID，代表特定裝置的特定證據組合驗證。

例如：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。其中一個包含校對可能出現的不同狀態。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)

如果校對遭拒，會顯示其他原因。

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

這項 ID 是由發卡機構產生，且僅適用於該機構。這項資訊僅用於除錯，以找出遭拒原因。這是發行者用來識別這項拒絕的 ID。
聯集欄位 reason。An oneof between the various reasons a proofing could be rejected. 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。使用者可能必須完成的各種驗證問題之一。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 紀元開始算起的毫秒數表示。

已取消

這個類型沒有任何欄位。

代表已取消校對狀態的物件。這則訊息目前刻意留白，日後可能會新增欄位。

已撤銷

這個類型沒有任何欄位。

代表已撤銷驗證狀態的物件。這則訊息目前刻意留白，日後可能會新增欄位。

已過期

這個類型沒有任何欄位。

代表過期校對狀態的物件。這則訊息目前刻意留白，日後可能會新增欄位。