Method: vdc.getProofingStatus

Một điểm cuối để truy xuất trạng thái hiện tại của quy trình hiệu đính.

Yêu cầu HTTP

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

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string
}
Trường
requestMetadata

object (RequestMetadata)

Siêu dữ liệu về yêu cầu, bắt buộc trong tất cả các yêu cầu.
deviceReferenceId

string

Mã nhận dạng tương ứng với thiết bị và khoá nhận dạng được liên kết với thiết bị. Đây KHÔNG phải là mã nhận dạng thiết bị, tức là nếu người dùng có hai thông tin đăng nhập riêng biệt trên cùng một thiết bị, thì mã nhận dạng này sẽ khác nhau giữa hai thông tin đăng nhập đó.

Mã nhận dạng này được cung cấp trong tất cả các yêu cầu và có thể dùng để tương quan các yêu cầu.
proofingId

string

Giá trị nhận dạng không công khai đại diện cho một quy trình chứng minh bằng một gói bằng chứng cụ thể cho một thiết bị cụ thể.

Ví dụ: UUID

Nội dung phản hồi

Phản hồi chứa trạng thái hiện tại của một quy trình hiệu đính.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingStatus": {
    object (ProofingStatus)
  }
}
Trường
responseMetadata

object (ResponseMetadata)

Siêu dữ liệu về phản hồi, bắt buộc trong tất cả các phản hồi.
proofingStatus

object (ProofingStatus)

Trạng thái hiện tại của quy trình hiệu đính.

ProofingStatus

Một đối tượng đại diện cho các trạng thái khác nhau mà quy trình hiệu đính có thể có.

Biểu diễn dưới dạng 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.
}
Trường
Trường nhóm status. Một oneof chứa các trạng thái có thể có của một quy trình hiệu đính. status chỉ có thể là một trong những trạng thái sau:
pending

object (Pending)

Trạng thái đang chờ xử lý, cho biết tổ chức phát hành chưa đưa ra quyết định.
accepted

object (Accepted)

Trạng thái được chấp nhận, cho biết tổ chức phát hành đã chấp nhận quy trình xác minh.
rejected

object (Rejected)

Trạng thái bị từ chối, cho biết tổ chức phát hành đã từ chối quy trình xác minh.
challenged

object (Challenged)

Trạng thái được yêu cầu xác minh, cho biết tổ chức phát hành muốn người dùng hoàn tất một quy trình xác minh trước khi tổ chức phát hành đưa ra quyết định về quy trình xác minh.
canceled

object (Canceled)

Trạng thái đã huỷ, cho biết người dùng đã huỷ quy trình hiệu đính.
revoked

object (Revoked)

Trạng thái thu hồi, cho biết tổ chức phát hành đã thu hồi quy trình xác minh.
expired

object (Expired)

Trạng thái đã hết hạn, cho biết quy trình xác minh chưa có quyết định (có thể là do chưa hoàn tất một thử thách) trước thời hạn do tổ chức phát hành đặt ra.

Đang chờ xử lý

Loại này không có trường nào.

Một đối tượng đại diện cho trạng thái đang chờ xử lý. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

Đã chấp nhận

Loại này không có trường nào.

Một đối tượng đại diện cho trạng thái xác minh được chấp nhận.

Bị từ chối

Một đối tượng biểu thị trạng thái hiệu đính bị từ chối.

Biểu diễn dưới dạng JSON 
{
  "primaryRejection": {
    object (Rejection)
  },
  "additionalRejections": [
    {
      object (Rejection)
    }
  ]
}
Trường
primaryRejection

object (Rejection)

Lý do chính khiến bản hiệu đính này có trạng thái bị từ chối.
additionalRejections[]

object (Rejection)

Các lý do khác (nếu có) khiến bản chứng minh có trạng thái bị từ chối.

Từ chối

Một đối tượng chứa thông tin chi tiết về một lý do từ chối cụ thể, dẫn đến việc bản duyệt có trạng thái bị từ chối.

Biểu diễn dưới dạng 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.
}
Trường
rejectionDescription

string

Nội dung mô tả về lý do từ chối này để nhân viên hỗ trợ gỡ lỗi. Xin lưu ý rằng người dùng sẽ không bao giờ thấy thông tin này. Nội dung này có thể chứa văn bản mô tả, không nhạy cảm dùng để gỡ lỗi.

Cảnh báo: Đừng đưa thông tin nhận dạng cá nhân vào tin nhắn này.
issuerRejectionIdentifier

string

Giá trị nhận dạng này dành riêng cho công ty phát hành và do công ty phát hành tạo. Mã này chỉ được dùng cho mục đích gỡ lỗi để xác định lý do từ chối. Đây là giá trị nhận dạng mà tổ chức phát hành biết được lý do từ chối này.
Trường nhóm reason. Một trong số các lý do khiến bản hiệu đính có thể bị từ chối. reason chỉ có thể là một trong những trạng thái sau:
evidenceMismatch

object (EvidenceMismatch)

Cho biết rằng quy trình hiệu đính đã bị từ chối do bằng chứng không khớp.

Ví dụ về trường hợp sử dụng: – Ảnh tự chụp chân dung do ứng dụng chụp không khớp với hình ảnh trong hệ thống của bên phát hành. – Hình ảnh chụp màn hình ứng dụng không khớp với hình ảnh trong hệ thống của tổ chức phát hành.
evidenceIncomplete

object (EvidenceIncomplete)

Cho biết rằng yêu cầu chứng minh đã bị từ chối do bằng chứng không đầy đủ.

Ví dụ về trường hợp sử dụng: – Bên phát hành chưa nhận được tất cả bằng chứng bắt buộc.
lowRiskScore
(deprecated)

object (LowRiskScore)

(KHÔNG DÙNG NỮA: hãy sử dụng riskCheckFailure hoặc livenessCheckFailure cho phù hợp)

Cho biết rằng quy trình kiểm chứng đã bị từ chối do điểm rủi ro thấp.

Ví dụ về trường hợp sử dụng: – Điểm rủi ro do ví cung cấp ở mức thấp. – Nhà phát hành đã khoá người dùng này do người dùng này nhiều lần đăng nhập không thành công.
recordNotFound

object (RecordNotFound)

Cho biết rằng quy trình chứng minh đã bị từ chối do không có bản ghi trong hệ thống của tổ chức phát hành.

Ví dụ về trường hợp sử dụng: – Không tìm thấy bản ghi trong hệ thống của tổ chức phát hành. – Một bản ghi cụ thể được chọn không tham gia.
recordInvalid

object (RecordInvalid)

Cho biết rằng quy trình chứng minh đã bị từ chối do bản ghi trong hệ thống của tổ chức phát hành ở trạng thái không hợp lệ.

Ví dụ về cách sử dụng: – Bản ghi ở trạng thái đã huỷ. – Bản ghi đã hết hạn.
maxProvisioningsReached

object (MaxProvisioningsReached)

Cho biết rằng bản xem trước bị từ chối do bạn đã cung cấp tài liệu cho số lượng thiết bị tối đa được phép.
riskCheckFailure

object (RiskCheckFailure)

Cho biết rằng quy trình hiệu đính đã bị từ chối do không vượt qua quy trình kiểm tra điểm số rủi ro.

Ví dụ về trường hợp sử dụng: – Điểm rủi ro do ví cung cấp ở mức cao, cho thấy nguy cơ gian lận cao. – Bên phát hành đánh giá rằng yêu cầu có nguy cơ cao xảy ra hành vi gian lận.
livenessCheckFailure

object (LivenessCheckFailure)

Cho biết rằng quy trình xác minh đã bị từ chối do không kiểm tra được sự sống.

Ví dụ về trường hợp sử dụng: – Điểm số về tính chân thực do ví cung cấp ở mức thấp.

EvidenceMismatch

Một đối tượng cho biết trường hợp từ chối do bằng chứng không khớp.

Biểu diễn dưới dạng JSON 
{
  "evidenceType": string
}
Trường
evidenceType

string

Nội dung mô tả về bằng chứng không khớp. Chỉ dùng cho mục đích gỡ lỗi.

EvidenceIncomplete

Một đối tượng cho biết bằng chứng bị từ chối do chưa hoàn chỉnh.

Biểu diễn dưới dạng JSON 
{
  "evidenceType": string
}
Trường
evidenceType

string

Nội dung mô tả về bằng chứng chưa đầy đủ. Chỉ dùng cho mục đích gỡ lỗi.

LowRiskScore

Loại này không có trường nào.

Một đối tượng cho biết yêu cầu bị từ chối do điểm số rủi ro thấp. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

RecordNotFound

Loại này không có trường nào.

Một đối tượng cho biết yêu cầu bị từ chối do không tìm thấy bản ghi. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

RecordInvalid

Một đối tượng cho biết việc từ chối bản ghi không hợp lệ.

Biểu diễn dưới dạng JSON 
{
  "invalidityReason": string
}
Trường
invalidityReason

string

Nội dung mô tả lý do bản ghi không hợp lệ.

MaxProvisioningsReached

Một đối tượng cho biết yêu cầu bị từ chối do đạt đến số lượng tối đa được cấp phép.

Biểu diễn dưới dạng JSON 
{
  "maxNumberOfProvisioningsAllowed": integer
}
Trường
maxNumberOfProvisioningsAllowed

integer

Số lượng tối đa các hoạt động cấp phép được phép, theo chính sách của tổ chức phát hành.

RiskCheckFailure

Loại này không có trường nào.

Một đối tượng cho biết yêu cầu bị từ chối do không vượt qua bước kiểm tra rủi ro. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

LivenessCheckFailure

Loại này không có trường nào.

Một đối tượng cho biết yêu cầu kiểm tra khuôn mặt trực tiếp bị từ chối. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

Thử thách

Một đối tượng đại diện cho trạng thái xác minh bị phản đối.

Biểu diễn dưới dạng 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.
}
Trường
challengeDescription

string

Nội dung mô tả về vấn đề để nhân viên hỗ trợ gỡ lỗi. Xin lưu ý rằng người dùng sẽ không bao giờ thấy thông tin này. Nội dung này có thể chứa văn bản mô tả, không nhạy cảm dùng để gỡ lỗi.

Cảnh báo: Đừng đưa thông tin nhận dạng cá nhân vào tin nhắn này.
Trường nhóm challenge. Một trong số những thử thách mà người dùng có thể phải hoàn thành. challenge chỉ có thể là một trong những trạng thái sau:
physicalLocationVisit

object (PhysicalLocationVisit)

Một thử thách mà người dùng phải đến một địa điểm thực tế, chẳng hạn như văn phòng của tổ chức phát hành, để hoàn thành thử thách.
issuerUrlVisit

object (IssuerUrlVisit)

Một lựa chọn thử thách mà người dùng phải truy cập vào một URL do tổ chức phát hành cung cấp và hoàn thành một thử thách tại URL đó.
additionalTimeRequired

object (AdditionalTimeRequired)

Một lựa chọn xác minh trong trường hợp bạn cần thêm thời gian để xem xét bằng chứng này.

PhysicalLocationVisit

Loại này không có trường nào.

Một đối tượng đại diện cho lựa chọn thử thách mà người dùng phải đến một địa điểm thực tế, chẳng hạn như văn phòng của tổ chức phát hành, để hoàn thành thử thách. Thử thách này nằm ngoài phạm vi của Google. Vì lý do bảo mật, nếu hỗ trợ loại thử thách này, thì tổ chức phát hành phải cung cấp thông tin chi tiết về vị trí cho Google trong quá trình tham gia.

IssuerUrlVisit

Loại này không có trường nào.

Một đối tượng đại diện cho lựa chọn thử thách mà người dùng phải truy cập vào một URL do tổ chức phát hành cung cấp và hoàn thành thử thách tại URL đó. Thử thách này nằm ngoài phạm vi của Google. Vì lý do bảo mật, nếu hỗ trợ loại thử thách này, thì tổ chức phát hành phải cung cấp URL cho Google trong quá trình tham gia.

AdditionalTimeRequired

Một đối tượng đại diện cho lựa chọn thử thách mà bạn cần thêm thời gian để xem xét bằng chứng. Bạn có thể cung cấp thời gian hoàn thành ước tính (không bắt buộc).

Biểu diễn dưới dạng JSON 
{
  "estimatedCompletion": string
}
Trường
estimatedCompletion

string (int64 format)

Thời gian ước tính hoàn tất quy trình hiệu đính. quy trình xem xét (nếu có). Định dạng này là dấu thời gian và dấu thời gian được biểu thị bằng số mili giây kể từ thời gian bắt đầu của hệ thống Unix.

Bị hủy

Loại này không có trường nào.

Một đối tượng biểu thị trạng thái hiệu đính đã huỷ. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

Đã bị thu hồi

Loại này không có trường nào.

Một đối tượng biểu thị trạng thái xác minh đã bị thu hồi. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.

Đã hết hạn

Loại này không có trường nào.

Một đối tượng biểu thị trạng thái xác minh đã hết hạn. Thông báo này hiện đang cố tình để trống. Các trường mới có thể được thêm vào trong tương lai.