نقطة نهاية لإثبات هوية المستخدم باستخدام قائمة مستندات إثبات الهوية التي تحدّدها جهة الإصدار، وذلك لجهاز معيّن.
طلب HTTP
POST https://example.issuer.com/api/v1/vdc/proofUser
نص الطلب
يتضمن نص الطلب بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{ "requestMetadata": { object ( |
| الحقول | |
|---|---|
requestMetadata |
الحقل مطلوب. البيانات الوصفية المتعلّقة بالطلب، وهي مطلوبة في جميع الطلبات |
deviceReferenceId |
الحقل مطلوب. المعرّف الذي يتوافق مع الجهاز ومفتاح الهوية المرتبط بالجهاز هذا ليس معرّف جهاز، ما يعني أنّه إذا كان لدى المستخدم بيانات اعتماد منفصلة على الجهاز نفسه، سيختلف هذا المعرّف بينهما. يتم تقديم رقم التعريف هذا في جميع الطلبات، ويمكن استخدامه لربط الطلبات. |
proofingId |
الحقل مطلوب. معرّف غير شفاف يمثّل عملية إثبات هوية باستخدام حزمة محدّدة من المستندات الثبوتية لجهاز معيّن. مثال: UUID |
evidence[] |
الحقل مطلوب. قائمة المستندات المطلوبة لإثبات هوية المستخدم للحصول على مستند تعريف رقمي |
حقل الربط proofing_context تمثّل هذه السمة سياق إثبات الملكية. اترك هذا الحقل فارغًا لإجراء عملية إثبات الهوية الأولية. يمكن أن يكون التعليق proofing_context إحدى القيم التالية فقط: |
|
reverificationContext |
سياق إثبات إعادة التحقّق |
نص الاستجابة
إشعار باستلام طلب إثبات هوية المستخدم للحصول على بيانات اعتماد رقمية، يشير إلى أنّ عملية إثبات الهوية قيد المعالجة حاليًا.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{
"responseMetadata": {
object ( |
| الحقول | |
|---|---|
responseMetadata |
الحقل مطلوب. البيانات الوصفية المتعلّقة بالردّ، وهي مطلوبة في جميع الردود |
proofingId |
الحقل مطلوب. المعرّف غير الشفاف الذي يمثّل عملية إثبات الهوية باستخدام حزمة معيّنة من المستندات لجهاز معيّن. وهو رقم تعريف المستند نفسه الذي تم إرساله في الطلب. |
ProofingEvidence
تمثّل هذه السمة مستندًا واحدًا.
| تمثيل JSON |
|---|
{ // Union field |
| الحقول | |
|---|---|
حقل الربط evidence_type الحقل مطلوب. حقل oneof يشير إلى طريقة عرض الدليل. يمكن أن يكون التعليق evidence_type إحدى القيم التالية فقط: |
|
preAuthorizationCode |
رمز التفويض المسبق الذي أرسلته جهة الإصدار |
الدليل
تمثّل هذه السمة مستندًا واحدًا.
| تمثيل JSON |
|---|
{ // Union field |
| الحقول | |
|---|---|
حقل الربط presencetype الحقل مطلوب. حقل oneof يشير إلى طريقة عرض الدليل. يمكن أن يكون التعليق presencetype إحدى القيم التالية فقط: |
|
encryptedData |
القيمة المشفّرة وبيانات التشفير الوصفية اللازمة لفك تشفير القيمة |
unencryptedValue |
قيمة الدليل المرمّزة باستخدام Base64 |
unencryptedInteger |
قيمة العدد الصحيح للدليل |
ReverificationContext
السياق المطلوب لتفعيل إعادة إثبات ملكية المستند.
| تمثيل JSON |
|---|
{ "credentialId": string } |
| الحقول | |
|---|---|
credentialId |
الحقل مطلوب. معرّف الاعتماد الذي يتم إجراء عملية إعادة التحقّق منه. |