الانتقال إلى المحتوى الرئيسي
POST
cURL
ابدأ التحقق عبر FranceConnect من الخادم الخلفي لتطبيقك باستخدام مفتاح API الخاص بالتطبيق. لا تحتاج إلى سير عمل أو إلى workflow_id. تصف استجابة البدء إجراء المصادقة التالي، وليست نتيجة هوية مقبولة.

التغطية والتفعيل

يختلف تفعيل المحفظة عن نشر الواجهة البرمجية وعن أهلية تطبيقك. endpoint موثّق لا يفعّل محفظة مُعلَّمة بعبارة «قريباً». للاطلاع على الأسعار المنشورة حاليًا، راجع أسعار محافظ الهوية الرقمية.

ما الذي يفعله الشخص

اتبع الإجراء التالي الذي يعيده طلب البدء. تحدد تجربة المصادقة في المحفظة ما إذا كان الشخص سيستخدم متصفحًا أو جهازًا آخر أو تطبيقًا.

استلام النتيجة

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

ذات صلة

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

الترويسات

Idempotency-Key
string

مفتاح اختياري لأمان إعادة المحاولة (بحد أقصى 255 حرفاً). تؤدي إعادة المحاولة بنفس المفتاح والمحفظة ونص الطلب إلى إرجاع عملية التحقق الأصلية دون بدء تسجيل دخول ثانٍ؛ أما استخدام نفس المفتاح مع محفظة أو نص طلب آخر فيُرجع 409 idempotency_key_reused.

الجسم

بدء عملية تحقق عبر FranceConnect (FRA).

return_url
string<uri>
مطلوب

عنوان URL بصيغة https يعود إليه متصفح المستخدم بعد المحفظة، مع إلحاق request_id وresult. يجب أن يكون المضيف مسجلاً في allowed_return_hosts للتطبيق (أو يكون نطاق العلامة البيضاء الخاص به). لا تعتمد أبداً على result بمفردها: اقرأ النتيجة عبر GET .../verifications/{request_id}/ أو webhook.

Required string length: 1 - 2048
vendor_data
string | null

المرجع الخاص بك لعملية التحقق هذه (مثل معرّف المستخدم لديك). يُعاد في النتائج وwebhook.

metadata
object | null

كائن JSON اختياري يُخزن مع التحقق ويُعاد في النتائج وwebhook.

sandbox_scenario
string

لتطبيقات البيئة التجريبية فقط: النتيجة المحاكاة - 'wallet_cancelled' أو 'wallet_timeout' أو 'wallet_provider_error'؛ وأي سيناريو آخر (أو عدم تحديد أي سيناريو) يُكمل التحقق بنجاح. يُرفض في تطبيقات بيئة الإنتاج. القائمة الكاملة متاحة عبر GET /v1/sandbox/scenarios/.

Minimum string length: 1
country
enum<string>
افتراضي:FRA

دولة هوية FranceConnect وفق المعيار ISO 3166-1 alpha-3. القيمة الافتراضية هي FRA، وهي الدولة الوحيدة التي تخدمها.

  • FRA - FRA
الخيارات المتاحة:
FRA
device
enum<string>
افتراضي:same_device

القيمة same_device عندما يسجل المستخدم الدخول على الجهاز الذي يعرض صفحتك، وcross_device عندما يستخدم جهازاً آخر (مثل رمز QR الخاص بـ BankID).

  • same_device - same_device
  • cross_device - cross_device
الخيارات المتاحة:
same_device,
cross_device

الاستجابة

عملية تحقق مستقلة واحدة من المحفظة، كما تُجيب عنها كل endpoint للمحفظة.

request_id
string<uuid>
مطلوب
wallet_verification
object
مطلوب
vendor_data
string | null
مطلوب
metadata
object | null
مطلوب

كائن البيانات الوصفية المرسل في البداية، أو null.

created_at
string<date-time>
مطلوب
آخر تعديل في ٧ نوفمبر ٢٠٢٦