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

یک شناسه‌ی مبهم که نشان‌دهنده‌ی اثبات با مجموعه‌ای خاص از شواهد، برای یک دستگاه خاص است.

مثال: شناسه کاربری

بدنه پاسخ

پاسخی که حاوی وضعیت فعلی یک نمونه‌برداری است.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingStatus": {
    object (ProofingStatus)
  }
}
فیلدها
responseMetadata

object ( ResponseMetadata )

فراداده مربوط به پاسخ، که در همه پاسخ‌ها الزامی است.

proofingStatus

object ( 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 )

دلایل اضافی، در صورت وجود، که چرا اثبات، وضعیت رد شده دارد.

رد شدن

شیء حاوی جزئیاتی در مورد دلیل خاص رد شدن، که منجر به اثباتی با وضعیت رد شده می‌شود.

نمایش 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 )

نشان می‌دهد که اثبات به دلیل عدم موفقیت در بررسی زنده بودن، رد شده است.

نمونه‌هایی از کاربرد: - امتیاز زنده بودن کیف پول ارائه شده پایین است.

عدم تطابق شواهد

شیئی که نشان‌دهنده‌ی رد عدم تطابق شواهد است.

نمایش JSON 
{
  "evidenceType": string
}
فیلدها
evidenceType

string

شرح شواهدی که تطابق نداشتند. فقط برای اهداف اشکال‌زدایی استفاده می‌شود.

شواهد ناقص

شیئی که نشان‌دهنده‌ی رد ناقص شواهد است.

نمایش JSON 
{
  "evidenceType": string
}
فیلدها
evidenceType

string

شرحی از شواهدی که ناقص بوده‌اند. فقط برای اهداف اشکال‌زدایی استفاده می‌شود.

امتیاز ریسک پایین

این نوع هیچ فیلدی ندارد.

یک شیء که نشان‌دهنده‌ی رد امتیاز ریسک پایین است. این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می‌توانند در آینده اضافه شوند.

رکورد پیدا نشد

این نوع هیچ فیلدی ندارد.

شیء‌ای که نشان‌دهنده‌ی رد شدن یک رکورد است. این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می‌توانند در آینده اضافه شوند.

رکورد نامعتبر

یک شیء که نشان‌دهنده‌ی رد شدن یک رکورد نامعتبر است.

نمایش JSON 
{
  "invalidityReason": string
}
فیلدها
invalidityReason

string

توضیحی در مورد اینکه چرا رکورد نامعتبر است.

حداکثر تأمین منابع

یک شیء که نشان‌دهنده‌ی حداکثر میزان تأمین است، به مرحله‌ی رد شدن رسیده است.

نمایش JSON 
{
  "maxNumberOfProvisioningsAllowed": integer
}
فیلدها
maxNumberOfProvisioningsAllowed

integer

حداکثر تعداد ذخایر مجاز، همانطور که توسط سیاست صادرکننده تعیین شده است.

بررسی ریسک (RiskCheckFailure)

این نوع هیچ فیلدی ندارد.

یک شیء که نشان‌دهنده‌ی رد شدن بررسی ریسک با شکست است. این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می‌توانند در آینده اضافه شوند.

بررسی عدم موفقیت در بررسی زنده بودن

این نوع هیچ فیلدی ندارد.

یک شیء که نشان‌دهنده‌ی رد شدن عدم موفقیت در بررسی زنده بودن است. این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می‌توانند در آینده اضافه شوند.

به چالش کشیده شده

شیء‌ای که نشان‌دهنده‌ی وضعیت اثبات مورد چالش است.

نمایش 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 )

یک گزینه چالش‌برانگیز که در آن زمان بیشتری برای بررسی این تصحیح مورد نیاز است.

موقعیت مکانی فیزیکیبازدید

این نوع هیچ فیلدی ندارد.

یک شیء که نشان‌دهنده گزینه چالش است که در آن کاربر باید برای تکمیل یک چالش به یک مکان فیزیکی، مانند دفتر صادرکننده، مراجعه کند. این چالش خارج از محدوده گوگل است. به دلایل امنیتی، اگر صادرکننده از این نوع چالش پشتیبانی می‌کند، باید جزئیات مکان را در هنگام ثبت‌نام به گوگل ارائه دهد.

IssuerUrlVisit

این نوع هیچ فیلدی ندارد.

یک شیء که نشان‌دهنده‌ی گزینه‌ی چالش است که در آن کاربر باید از یک URL ارائه شده توسط صادرکننده بازدید کند و یک چالش را در آن URL تکمیل کند. این چالش خارج از محدوده‌ی گوگل است. به دلایل امنیتی، اگر صادرکننده از این نوع چالش پشتیبانی می‌کند، باید URL را در طول فرآیند ثبت‌نام به گوگل ارائه دهد.

زمان اضافی مورد نیاز

یک شیء که نشان‌دهنده‌ی گزینه‌ی چالش است که در آن برای بررسی تصحیح، زمان اضافی لازم است. زمان تخمینی تکمیل می‌تواند به صورت اختیاری ارائه شود.

نمایش JSON 
{
  "estimatedCompletion": string
}
فیلدها
estimatedCompletion

string ( int64 format)

زمان تخمینی که در آن تصحیح تکمیل خواهد شد. بررسی در صورت وجود. قالب آن یک مهر زمانی است و مهر زمانی به صورت تعداد میلی‌ثانیه‌ها از زمان آغاز یونیکس نمایش داده می‌شود.

لغو شد

این نوع هیچ فیلدی ندارد.

یک شیء که نشان‌دهنده‌ی وضعیت لغو شده‌ی نمونه‌گیری است. این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می‌توانند در آینده اضافه شوند.

لغو شد

این نوع هیچ فیلدی ندارد.

یک شیء که نشان‌دهنده‌ی وضعیت ابطال‌شده‌ی اثبات است. این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می‌توانند در آینده اضافه شوند.

منقضی شده

این نوع هیچ فیلدی ندارد.

یک شیء که نشان‌دهنده‌ی وضعیت اعتبارسنجی منقضی شده است. این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می‌توانند در آینده اضافه شوند.