मुख्य सामग्री पर जाएं
POST
cURL
अपने बैकएंड से अपनी एप्लिकेशन API कुंजी का उपयोग करके FranceConnect सत्यापन शुरू करें। आपको वर्कफ़्लो या workflow_id की आवश्यकता नहीं है। स्टार्ट रिस्पॉन्स अगली प्रमाणीकरण कार्रवाई का वर्णन करता है; यह स्वीकृत पहचान परिणाम नहीं है।

कवरेज और सक्रियण

वॉलेट सक्रियण API डिप्लॉयमेंट और आपके एप्लिकेशन की पात्रता से अलग है। कोई दस्तावेज़ीकृत endpoint उस वॉलेट को सक्रिय नहीं करता जिसे “जल्द आ रहा है” चिह्नित किया गया है। वर्तमान प्रकाशित दरों के लिए, डिजिटल ID वॉलेट मूल्य निर्धारण देखें।

व्यक्ति क्या करता है

स्टार्ट अनुरोध द्वारा लौटाई गई अगली कार्रवाई का पालन करें। वॉलेट का प्रमाणीकरण अनुभव तय करता है कि व्यक्ति ब्राउज़र, किसी अन्य डिवाइस या ऐप का उपयोग करता है।

परिणाम प्राप्त करें

सत्यापन को ट्रैक करने और उसका परिणाम प्राप्त करने के लिए डिजिटल ID वॉलेट API गाइड का पालन करें। केवल पूर्ण और सत्यापित परिणाम को ही इस बात का प्रमाण मानें कि वॉलेट ने व्यक्ति को प्रमाणित किया है। लौटाई गई पहचान विशेषताएँ वॉलेट के अनुसार भिन्न होती हैं; यह न मानें कि पता, पोर्ट्रेट या अनुरोध की गई हर विशेषता मौजूद होगी।

संबंधित

प्राधिकरण

x-api-key
string
header
आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

हेडर

Idempotency-Key
string

वैकल्पिक पुनः प्रयास-सुरक्षा कुंजी (अधिकतम 255 वर्ण)। समान कुंजी, वॉलेट और बॉडी के साथ पुनः प्रयास करने पर दूसरा साइन-इन शुरू किए बिना मूल सत्यापन वापस मिलता है; किसी अन्य वॉलेट या बॉडी के साथ समान कुंजी 409 idempotency_key_reused लौटाती है।

बॉडी

FranceConnect सत्यापन (FRA) शुरू करें।

return_url
string<uri>
आवश्यक

https URL जिस पर वॉलेट के बाद उपयोगकर्ता का ब्राउज़र वापस आता है, जिसमें request_id और result जुड़े होते हैं। इसका होस्ट एप्लिकेशन के allowed_return_hosts में पंजीकृत होना चाहिए (या इसका व्हाइट लेबल डोमेन होना चाहिए)। कभी भी केवल result पर भरोसा न करें: GET .../verifications/{request_id}/ या webhook से परिणाम पढ़ें।

Required string length: 1 - 2048
vendor_data
string | null

इस सत्यापन के लिए आपका अपना संदर्भ (उदा. आपका उपयोगकर्ता id)। परिणामों और webhooks में वापस किया जाता है।

metadata
object | null

सत्यापन के साथ संग्रहीत और परिणामों तथा webhook में लौटाया गया वैकल्पिक JSON ऑब्जेक्ट।

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 जब वे किसी अन्य डिवाइस का उपयोग करते हैं (जैसे BankID का QR कोड)।

  • 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>
आवश्यक
अंतिम संशोधन 7 नवंबर 2026