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 ではありません。つまり、ユーザーが同じデバイスで 2 種類の認証情報を使用する場合、この 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

サポート担当者がデバッグするための、この不承認に関する説明。ユーザーに対しては表示されません。デバッグに役立ち、機密情報を含まないテキストを含めることができます。

警告: このメッセージに個人を特定できる情報（PII）を含めないでください。
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

サポート担当者がデバッグするための、チャレンジに関する説明。ユーザーに対しては表示されません。デバッグに役立ち、機密情報を含まないテキストを含めることができます。

警告: このメッセージに個人を特定できる情報（PII）を含めないでください。
共用体フィールド challenge。ユーザーによる完了が必要な場合のある、さまざまなチャレンジの oneof。challenge は次のいずれかになります。
physicalLocationVisit

object (PhysicalLocationVisit)

本人確認を完了するためにユーザーが物理的な場所（発行元のオフィスなど）に行く必要があるチャレンジ。
issuerUrlVisit

object (IssuerUrlVisit)

発行元が提供する URL にユーザーがアクセスし、その URL で本人確認を完了する必要があるチャレンジ オプション。
additionalTimeRequired

object (AdditionalTimeRequired)

この校正の確認に時間がかかる場合のチャレンジ オプション。

PhysicalLocationVisit

この型にはフィールドがありません。

本人確認を完了するためにユーザーが物理的な場所（発行元のオフィスなど）に行く必要がある、チャレンジ オプションを表すオブジェクト。このチャレンジは Google の管轄外です。セキュリティ上の理由から、発行元がこの種のチャレンジをサポートする場合、Google に対してオンボーディング時に、位置情報の詳細を提示する必要があります。

IssuerUrlVisit

この型にはフィールドがありません。

発行元が提供する URL にユーザーがアクセスし、その URL で本人確認を完了する必要がある、チャレンジ オプションを表すオブジェクト。このチャレンジは Google の管轄外です。セキュリティ上の理由から、発行元がこの種のチャレンジをサポートする場合、Google に対してオンボーディング時に URL を提示する必要があります。

AdditionalTimeRequired

検証の確認に時間がかかるチャレンジ オプションを表すオブジェクト。推定完了時間は任意で指定できます。

JSON 表現 
{
  "estimatedCompletion": string
}
フィールド
estimatedCompletion

string (int64 format)

校正が完了する予定時刻。審査が利用可能な場合は審査。形式はタイムスタンプで、タイムスタンプは Unix エポックからの経過ミリ秒数として表されます。

キャンセル済み

この型にはフィールドがありません。

キャンセルの検証ステータスを表すオブジェクト。このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

取り消し済み

この型にはフィールドがありません。

取り消しの検証ステータスを表すオブジェクト。このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。

期限切れ

この型にはフィールドがありません。

期限切れの検証ステータスを表すオブジェクト。このメッセージは今、意図的に空になっています。今後、新しいフィールドが追加される可能性があります。