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

המזהה שמתאים למכשיר ולמפתח הזהות שמשויך למכשיר. זה לא מזהה מכשיר, כלומר אם למשתמש יש שני פרטי כניסה נפרדים באותו מכשיר, המזהה הזה יהיה שונה בשני המקרים.

המזהה הזה מסופק בכל הבקשות, ואפשר להשתמש בו כדי ליצור קורלציה בין בקשות.
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. אחד מבין הסיבות השונות לדחיית ההגהה. הערך 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. אחד מבין האתגרים השונים שהמשתמש עשוי להצטרך להשלים. הערך 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)

הזמן המשוער שבו תסתיים ההגהה. הבדיקה, אם היא זמינה. הפורמט הוא חותמת זמן, והיא מיוצגת כמספר המילישניות מאז ראשית זמן יוניקס.

בוטל

בסוג הזה אין שדות.

אובייקט שמייצג סטטוס של ביטול בדיקה. ההודעה הזו ריקה בכוונה כרגע. יכול להיות שבעתיד נוסיף עוד שדות.

בוטל

בסוג הזה אין שדות.

אובייקט שמייצג סטטוס אימות שבוטל. ההודעה הזו ריקה בכוונה כרגע. יכול להיות שבעתיד נוסיף עוד שדות.

פג תוקף

בסוג הזה אין שדות.

אובייקט שמייצג סטטוס אימות שתוקפו פג. ההודעה הזו ריקה בכוונה כרגע. יכול להיות שבעתיד נוסיף עוד שדות.