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

وصف لسبب الرفض كي يتمكّن ممثلو الدعم من تحديد المشاكل وحلّها. يُرجى العِلم أنّ هذا المعرّف لا يظهر للمستخدمين مطلقًا. يمكن أن يحتوي على نص وصفي غير حسّاس يُستخدم لتصحيح الأخطاء.

تحذير: لا تُدرِج أي معلومات تعريف شخصية في هذه الرسالة.
issuerRejectionIdentifier

string

هذا المعرّف خاص بجهة الإصدار ويتم إنشاؤه من قِبلها. ويتم استخدامه لأغراض تصحيح الأخطاء فقط من أجل تحديد سبب الرفض. هذا هو المعرّف الذي تعرف جهة الإصدار سبب الرفض من خلاله.
حقل الربط reason الحقل مطلوب. An oneof between the various reasons a proofing could be rejected. يمكن أن يكون التعليق 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

الحقل مطلوب. وصف للتحدي يمكن لممثلي الدعم استخدامه لتحديد المشاكل وحلّها يُرجى العِلم أنّ هذا المعرّف لا يظهر للمستخدمين مطلقًا. يمكن أن يحتوي على نص وصفي غير حسّاس يُستخدم لتصحيح الأخطاء.

تحذير: لا تُدرِج أي معلومات تعريف شخصية في هذه الرسالة.
حقل الربط challenge الحقل مطلوب. تمثّل هذه السمة أحد التحديات المختلفة التي قد يواجهها المستخدم. يمكن أن يكون التعليق challenge إحدى القيم التالية فقط:
physicalLocationVisit

object (PhysicalLocationVisit)

اختبار يتطلّب من المستخدم زيارة موقع جغرافي، مثل مكتب جهة إصدار المستند، لإكماله.
issuerUrlVisit

object (IssuerUrlVisit)

خيار اختبار يتطلّب من المستخدم الانتقال إلى عنوان URL يقدّمه جهة الإصدار وإكمال الاختبار في هذا العنوان
additionalTimeRequired

object (AdditionalTimeRequired)

خيار إثبات الهوية الذي يتطلّب المزيد من الوقت لمراجعة عملية إثبات الهوية هذه

PhysicalLocationVisit

لا يتضمّن هذا النوع أي حقول.

عنصر يمثّل خيار إثبات الهوية الذي يتطلّب من المستخدم زيارة موقع جغرافي فعلي، مثل مكتب جهة إصدار المستند، لإكمال عملية إثبات الهوية. هذا التحدّي خارج نطاق Google. لأسباب أمنية، إذا كان جهة الإصدار تتيح هذا النوع من التحدّي، عليها تقديم تفاصيل الموقع الجغرافي إلى Google أثناء عملية الإعداد.

IssuerUrlVisit

لا يتضمّن هذا النوع أي حقول.

عنصر يمثّل خيار التحقّق حيث يجب على المستخدم الانتقال إلى عنوان URL يقدّمه جهة الإصدار وإكمال عملية التحقّق في عنوان URL هذا. هذا التحدّي خارج نطاق Google. لأسباب أمنية، إذا كان جهة الإصدار توفّر هذا النوع من التحدّي، عليها تقديم عنوان URL إلى Google أثناء عملية الإعداد.

AdditionalTimeRequired

كائن يمثّل خيار إثبات الهوية الذي يتطلّب وقتًا إضافيًا لمراجعة عملية إثبات الهوية يمكنك تقديم الوقت المقدَّر لإكمال عملية التصدير بشكل اختياري.

تمثيل JSON 
{
  "estimatedCompletion": string
}
الحقول
estimatedCompletion

string (int64 format)

الوقت المقدَّر الذي ستكتمل فيه عملية إثبات الملكية والمراجعة إذا كانت متاحة التنسيق هو طابع زمني ويتم تمثيله بعدد الملّي ثانية منذ بدء حقبة يونكس.

تم الإلغاء

لا يتضمّن هذا النوع أي حقول.

تمثّل هذه السمة عنصرًا يمثّل حالة إثبات ملكية تم إلغاؤها. هذه الرسالة فارغة عمدًا في الوقت الحالي. قد تتم إضافة حقول جديدة في المستقبل.

تم إبطاله

لا يتضمّن هذا النوع أي حقول.

تمثّل هذه السمة حالة إثبات هوية تم إبطالها. هذه الرسالة فارغة عمدًا في الوقت الحالي. قد تتم إضافة حقول جديدة في المستقبل.

انتهت الصلاحية

لا يتضمّن هذا النوع أي حقول.

كائن يمثّل حالة إثبات هوية منتهية الصلاحية. هذه الرسالة فارغة عمدًا في الوقت الحالي. قد تتم إضافة حقول جديدة في المستقبل.