- طلب HTTP
- نص الطلب
- نص الاستجابة
- ProofingStatus
- في انتظار المراجعة
- مقبول
- مرفوضة
- الرفض
- EvidenceMismatch
- EvidenceIncomplete
- LowRiskScore
- RecordNotFound
- RecordInvalid
- MaxProvisioningsReached
- RiskCheckFailure
- LivenessCheckFailure
- تم الاعتراض عليها
- PhysicalLocationVisit
- IssuerUrlVisit
- AdditionalTimeRequired
- الفعالية مُلغاة
- تم إبطالها
- منتهية الصلاحية
نقطة نهاية لاسترداد الحالة الحالية لعملية إثبات الملكية
طلب HTTP
POST https://example.issuer.com/api/v1/vdc/getProofingStatus
نص الطلب
يتضمن نص الطلب بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{
"requestMetadata": {
object ( |
| الحقول | |
|---|---|
requestMetadata |
البيانات الوصفية المتعلّقة بالطلب، وهي مطلوبة في جميع الطلبات |
deviceReferenceId |
المعرّف الذي يتوافق مع الجهاز ومفتاح الهوية المرتبط بالجهاز هذا ليس معرّف جهاز، ما يعني أنّه إذا كان لدى المستخدم بيانات اعتماد منفصلة على الجهاز نفسه، سيختلف هذا المعرّف بينهما. يتم تقديم رقم التعريف هذا في جميع الطلبات، ويمكن استخدامه لربط الطلبات. |
proofingId |
معرّف مبهم يمثّل عملية إثبات هوية تتضمّن حزمة معيّنة من المستندات لجهاز معيّن. مثال: UUID |
نص الاستجابة
استجابة تتضمّن الحالة الحالية لعملية إثبات الملكية
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{ "responseMetadata": { object ( |
| الحقول | |
|---|---|
responseMetadata |
البيانات الوصفية الخاصة بالرد، وهي مطلوبة في جميع الردود. |
proofingStatus |
تعرض هذه السمة الحالة الحالية لعملية التدقيق اللغوي. |
ProofingStatus
كائن يمثّل الحالات المختلفة التي يمكن أن تتضمّنها عملية التدقيق.
| تمثيل JSON |
|---|
{ // Union field |
| الحقول | |
|---|---|
حقل الربط status حقل oneof يحتوي على الحالات المختلفة الممكنة لعملية إثبات الملكية. يمكن أن يكون التعليق status إحدى القيم التالية فقط: |
|
pending |
حالة "في انتظار المراجعة"، ما يشير إلى أنّ الجهة المسؤولة لم تتّخذ قرارًا بعد |
accepted |
حالة مقبولة تشير إلى أنّ الجهة المُصدرة قبلت عملية إثبات الهوية |
rejected |
حالة مرفوضة تشير إلى أنّ جهة الإصدار رفضت عملية إثبات الهوية. |
challenged |
حالة "تم التحقّق من الهوية"، ما يشير إلى أنّ جهة الإصدار تريد من المستخدم إكمال عملية التحقّق قبل أن تتّخذ قرارًا بشأن إثبات الهوية |
canceled |
حالة "ملغاة"، تشير إلى أنّ المستخدم ألغى عملية إثبات الملكية. |
revoked |
حالة الإبطال، ما يشير إلى أنّ جهة الإصدار قد أبطلت عملية إثبات الهوية. |
expired |
حالة منتهية الصلاحية، ما يشير إلى أنّه لم يتم اتّخاذ قرار بشأن إثبات الهوية (من المحتمل أنّ السبب هو عدم إكمال عملية التحقّق) قبل الموعد النهائي الذي حدّدته الجهة المصدرة. |
في انتظار المراجعة
لا يتضمّن هذا النوع أي حقول.
عنصر يمثّل حالة "في انتظار المراجعة". هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.
مقبول
لا يتضمّن هذا النوع أي حقول.
كائن يمثّل حالة إثبات الملكية المقبولة.
تم الرفض
كائن يمثّل حالة إثبات هوية مرفوضة.
| تمثيل JSON |
|---|
{ "primaryRejection": { object ( |
| الحقول | |
|---|---|
primaryRejection |
السبب الأساسي لرفض عملية إثبات الملكية هذه. |
additionalRejections[] |
أسباب إضافية، إن وجدت، لحالة الرفض. |
الرفض
عنصر يحتوي على تفاصيل حول سبب رفض محدّد أدّى إلى أن تكون حالة المستند التجريبي مرفوضة.
| تمثيل JSON |
|---|
{ "rejectionDescription": string, "issuerRejectionIdentifier": string, // Union field |
| الحقول | |
|---|---|
rejectionDescription |
وصف لسبب الرفض هذا ليتمكّن ممثلو فريق الدعم من تحديد المشاكل وحلّها. يُرجى العِلم أنّ هذا المعرّف لا يظهر للمستخدمين مطلقًا. يمكن أن يحتوي على نص وصفي غير حسّاس يُستخدم لتصحيح الأخطاء. تحذير: لا تُدرِج أي معلومات تعريف شخصية في هذه الرسالة. |
issuerRejectionIdentifier |
هذا المعرّف خاص بجهة الإصدار ويتم إنشاؤه من قِبلها. ويتم استخدامه لأغراض تصحيح الأخطاء فقط من أجل تحديد سبب الرفض. هذا هو المعرّف الذي تعرف جهة الإصدار سبب الرفض من خلاله. |
حقل الربط reason تمثّل هذه السمة أحد الأسباب المختلفة التي قد تؤدي إلى رفض عملية إثبات الملكية. يمكن أن يكون التعليق reason إحدى القيم التالية فقط: |
|
evidenceMismatch |
تشير إلى أنّه تم رفض عملية إثبات الهوية بسبب عدم تطابق المستندات. أمثلة على الاستخدام: - عدم تطابق الصورة الذاتية التي تم التقاطها في التطبيق مع الصورة في نظام الجهة المصدرة - عدم تطابق صورة مستند التقاط التطبيق مع الصورة في نظام الجهة المصدرة |
evidenceIncomplete |
تشير إلى أنّه تم رفض عملية إثبات الملكية بسبب عدم اكتمال المستندات. أمثلة على الاستخدام: - لم يتلقَّ الجهة المصدرة جميع المستندات المطلوبة. |
lowRiskScore |
(متوقّف نهائيًا: استخدِم riskCheckFailure أو livenessCheckFailure حسب الاقتضاء) تشير إلى أنّه تم رفض عملية إثبات الهوية بسبب انخفاض مستوى المخاطر. أمثلة على الاستخدام: - كانت نتيجة تقييم المخاطر التي قدّمتها المحفظة منخفضة. - حظرت جهة الإصدار هذا المستخدم بسبب تكرار المحاولات الفاشلة. |
recordNotFound |
تشير إلى أنّه تم رفض عملية إثبات الهوية لأنّ السجلّ غير متوفّر في نظام جهة إصدار المستند. أمثلة على الاستخدام: - لم يتم العثور على السجلّ في نظام الجهة المُصدرة. - تم إيقاف ميزة "تتبُّع النشاط" لسجلّ معيّن. |
recordInvalid |
تشير إلى أنّه تم رفض عملية إثبات الملكية لأنّ السجلّ في نظام جهة إصدار البطاقة كان في حالة غير صالحة. أمثلة على الاستخدام: - السجلّ في حالة "تم الإلغاء". - انتهت صلاحية السجلّ. |
maxProvisioningsReached |
تشير إلى أنّه تم رفض التدقيق بسبب توفير المستند على الحد الأقصى لعدد الأجهزة المسموح به. |
riskCheckFailure |
تشير إلى أنّه تم رفض عملية إثبات الهوية بسبب تعذُّر التحقّق من درجة المخاطرة. أمثلة على الاستخدام: - درجة الخطورة التي قدّمتها المحفظة عالية، ما يشير إلى احتمال كبير لحدوث عمليات احتيال. - يرى الجهة المصدرة أنّ الطلب ينطوي على خطر كبير من الاحتيال. |
livenessCheckFailure |
تشير إلى أنّه تم رفض إثبات الهوية بسبب فشل التحقّق من النشاط. أمثلة على الاستخدام: - تقييم صحة المستند المقدَّم من المحفظة منخفض. |
EvidenceMismatch
تمثّل هذه السمة عنصرًا يشير إلى رفض بسبب عدم تطابق الأدلة.
| تمثيل JSON |
|---|
{ "evidenceType": string } |
| الحقول | |
|---|---|
evidenceType |
تمثّل هذه السمة وصفًا للأدلة التي لم تتطابق. يُستخدم لأغراض تصحيح الأخطاء فقط. |
EvidenceIncomplete
تمثّل هذه السمة عنصرًا يشير إلى رفض غير مكتمل للأدلة.
| تمثيل JSON |
|---|
{ "evidenceType": string } |
| الحقول | |
|---|---|
evidenceType |
وصف للأدلة غير المكتملة يُستخدم لأغراض تصحيح الأخطاء فقط. |
LowRiskScore
لا يتضمّن هذا النوع أي حقول.
كائن يشير إلى رفض نتيجة المخاطرة المنخفضة. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.
RecordNotFound
لا يتضمّن هذا النوع أي حقول.
كائن يشير إلى رفض عدم العثور على سجلّ. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.
RecordInvalid
كائن يشير إلى رفض سجلّ غير صالح.
| تمثيل JSON |
|---|
{ "invalidityReason": string } |
| الحقول | |
|---|---|
invalidityReason |
وصف لسبب عدم صلاحية السجلّ |
MaxProvisioningsReached
كائن يشير إلى رفض بسبب بلوغ الحد الأقصى لعدد عمليات التوفير.
| تمثيل JSON |
|---|
{ "maxNumberOfProvisioningsAllowed": integer } |
| الحقول | |
|---|---|
maxNumberOfProvisioningsAllowed |
الحد الأقصى لعدد عمليات التوفير المسموح بها، كما هو محدّد في سياسة الجهة المصدرة |
RiskCheckFailure
لا يتضمّن هذا النوع أي حقول.
كائن يشير إلى رفض نتيجة فحص المخاطر. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.
LivenessCheckFailure
لا يتضمّن هذا النوع أي حقول.
كائن يشير إلى رفض نتيجة فحص النشاط. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.
التحدّي
كائن يمثّل حالة إثبات الهوية التي تم الاعتراض عليها.
| تمثيل JSON |
|---|
{ "challengeDescription": string, // Union field |
| الحقول | |
|---|---|
challengeDescription |
وصف للتحدي كي يتمكّن ممثلو الدعم من تحديد المشكلة وحلّها يُرجى العِلم أنّ هذا المعرّف لا يظهر للمستخدمين مطلقًا. يمكن أن يحتوي على نص وصفي غير حسّاس يُستخدم لتصحيح الأخطاء. تحذير: لا تُدرِج أي معلومات تعريف شخصية في هذه الرسالة. |
حقل الربط challenge تمثّل هذه السمة أحد التحديات المختلفة التي قد يواجهها المستخدم. يمكن أن يكون التعليق challenge إحدى القيم التالية فقط: |
|
physicalLocationVisit |
اختبار يجب على المستخدم إكماله في مكان جغرافي، مثل مكتب جهة إصدار المستند. |
issuerUrlVisit |
أحد خيارات التحقّق من الهوية حيث يجب على المستخدم الانتقال إلى عنوان URL يقدّمه جهة الإصدار وإكمال اختبار التحقّق من الهوية في عنوان URL هذا |
additionalTimeRequired |
خيار إثبات الملكية الذي يتطلّب المزيد من الوقت لمراجعة عملية إثبات الملكية هذه |
PhysicalLocationVisit
لا يتضمّن هذا النوع أي حقول.
كائن يمثّل خيار التحقّق الذي يتطلّب من المستخدم زيارة موقع جغرافي فعلي، مثل مكتب جهة إصدار البطاقة، لإكمال عملية التحقّق. هذا التحدّي خارج نطاق Google. لأسباب أمنية، إذا كان جهة الإصدار تتيح هذا النوع من التحدّي، عليها تقديم تفاصيل الموقع الجغرافي إلى Google أثناء عملية الإعداد.
IssuerUrlVisit
لا يتضمّن هذا النوع أي حقول.
عنصر يمثّل خيار التحقّق حيث يجب على المستخدم الانتقال إلى عنوان URL يقدّمه جهة الإصدار وإكمال عملية التحقّق في عنوان URL هذا. هذا التحدّي خارج نطاق Google. لأسباب أمنية، إذا كان جهة الإصدار تتيح هذا النوع من التحدّي، عليها تقديم عنوان URL إلى Google أثناء عملية الإعداد.
AdditionalTimeRequired
كائن يمثّل خيار إثبات الهوية الذي يتطلّب وقتًا إضافيًا لمراجعة عملية إثبات الهوية. يمكنك تقديم الوقت المقدَّر لإكمال عملية التصدير بشكل اختياري.
| تمثيل JSON |
|---|
{ "estimatedCompletion": string } |
| الحقول | |
|---|---|
estimatedCompletion |
الوقت المقدَّر الذي سيتم فيه إكمال عملية التدقيق، والمراجعة إذا كانت متاحة التنسيق هو طابع زمني ويتم تمثيل الطابع الزمني على أنّه عدد الملّي ثانية منذ بدء حقبة يونكس. |
تم الإلغاء
لا يتضمّن هذا النوع أي حقول.
تمثّل هذه السمة عنصرًا يمثّل حالة إثبات ملكية تم إلغاؤها. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.
تم إبطاله
لا يتضمّن هذا النوع أي حقول.
كائن يمثّل حالة إثبات هوية تم إبطالها. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.
انتهت الصلاحية
لا يتضمّن هذا النوع أي حقول.
كائن يمثّل حالة إثبات هوية منتهية الصلاحية. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.