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

ต้องระบุ รหัสที่สอดคล้องกับอุปกรณ์และคีย์ข้อมูลประจำตัวที่เชื่อมโยงกับอุปกรณ์ นี่ไม่ใช่รหัสอุปกรณ์ ซึ่งหมายความว่าหากผู้ใช้มีข้อมูลเข้าสู่ระบบ 2 ชุดแยกกันในอุปกรณ์เดียวกัน รหัสนี้จะแตกต่างกัน

รหัสนี้จะระบุไว้ในคำขอทั้งหมด และใช้เพื่อเชื่อมโยงคำขอได้
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.
}
ช่อง
ฟิลด์ Union 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

ตัวระบุนี้เป็นของผู้ออกบัตรโดยเฉพาะและสร้างขึ้นโดยผู้ออกบัตร โดยใช้เพื่อการแก้ไขข้อบกพร่องเท่านั้นเพื่อระบุการปฏิเสธ นี่คือตัวระบุที่ผู้ออกบัตรทราบว่าการปฏิเสธนี้เกิดจากอะไร
ฟิลด์ Union 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 ในข้อความนี้
ฟิลด์ Union challenge ต้องระบุ ข้อใดข้อหนึ่งในความท้าทายต่างๆ ที่ผู้ใช้อาจต้องทำ challenge ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
physicalLocationVisit

object (PhysicalLocationVisit)

ภารกิจที่ผู้ใช้ต้องไปที่สถานที่ตั้งจริง เช่น สำนักงานของผู้ออกบัตร เพื่อทำภารกิจให้เสร็จสมบูรณ์
issuerUrlVisit

object (IssuerUrlVisit)

ตัวเลือกการยืนยันตัวตนที่ผู้ใช้ต้องไปที่ URL ที่ผู้ออกระบุ และทำการยืนยันตัวตนที่ URL นั้น
additionalTimeRequired

object (AdditionalTimeRequired)

ตัวเลือกการท้าทายในกรณีที่ต้องใช้เวลาเพิ่มเติมในการตรวจสอบการพิสูจน์นี้

PhysicalLocationVisit

ประเภทนี้ไม่มีฟิลด์

ออบเจ็กต์ที่แสดงตัวเลือกการยืนยันตัวตนที่ผู้ใช้ต้องไปที่สถานที่ตั้งจริง เช่น สำนักงานของผู้ออกบัตร เพื่อทำการยืนยันตัวตนให้เสร็จสมบูรณ์ ความท้าทายนี้อยู่นอกเหนือขอบเขตของ Google หากผู้ออกบัตรรองรับการยืนยันประเภทนี้ ผู้ออกบัตรจะต้องระบุรายละเอียดสถานที่ตั้งให้ Google ในระหว่างการเริ่มต้นใช้งานเพื่อความปลอดภัย

IssuerUrlVisit

ประเภทนี้ไม่มีฟิลด์

ออบเจ็กต์ที่แสดงตัวเลือกการท้าทายซึ่งผู้ใช้ต้องไปที่ URL ที่ผู้ออกบัตรระบุ และทำการท้าทายที่ URL นั้นให้เสร็จสมบูรณ์ ความท้าทายนี้อยู่นอกเหนือขอบเขตของ Google เพื่อความปลอดภัย หากผู้ออกใบรับรองรองรับการท้าทายประเภทนี้ ผู้ออกใบรับรองจะต้องระบุ URL ให้ Google ในระหว่างการเริ่มต้นใช้งาน

AdditionalTimeRequired

ออบเจ็กต์ที่แสดงตัวเลือกความท้าทายในกรณีที่ต้องใช้เวลาเพิ่มเติมในการตรวจสอบการพิสูจน์ คุณระบุเวลาที่ส่งออกเสร็จโดยประมาณหรือไม่ก็ได้

การแสดง JSON 
{
  "estimatedCompletion": string
}
ช่อง
estimatedCompletion

string (int64 format)

เวลาโดยประมาณที่การพิสูจน์อักษรจะเสร็จสมบูรณ์ การตรวจสอบ (หากมี) รูปแบบคือการประทับเวลา และการประทับเวลาจะแสดงเป็นจำนวนมิลลิวินาทีนับตั้งแต่ Epoch ของ Unix

ยกเลิกแล้ว

ประเภทนี้ไม่มีฟิลด์

ออบเจ็กต์ที่แสดงสถานะการพิสูจน์อักษรที่ยกเลิก ขณะนี้ข้อความนี้ตั้งใจให้ว่างเปล่า ทั้งนี้ อาจมีการเพิ่มช่องใหม่ในอนาคต

เพิกถอนแล้ว

ประเภทนี้ไม่มีฟิลด์

ออบเจ็กต์ที่แสดงสถานะการพิสูจน์ตัวตนที่ถูกเพิกถอน ขณะนี้ข้อความนี้ตั้งใจให้ว่างเปล่า ทั้งนี้ อาจมีการเพิ่มช่องใหม่ในอนาคต

หมดอายุ

ประเภทนี้ไม่มีฟิลด์

ออบเจ็กต์ที่แสดงสถานะการพิสูจน์ตัวตนที่หมดอายุแล้ว ขณะนี้ข้อความนี้ตั้งใจให้ว่างเปล่า ทั้งนี้ อาจมีการเพิ่มช่องใหม่ในอนาคต