> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Step-Up स्थिति प्राप्त करें | Didit Authentication API > Didit का GET /step-up/{step_up_id}/ step-up की स्थिति, विधि और स्तर लौटाता है। संवेदनशील कार्रवाई तभी करें जब स्थिति स्वीकृत हो। > [!WARNING] > > प्रमाणीकरण नया है। ये endpoint आपके एप्लिकेशन के जारीकर्ता द्वारा दिए जाते हैं, जैसे `https://.auth.didit.me`, और ये कभी आपकी Didit API कुंजी स्वीकार नहीं करते। स्टेप-अप उस सत्र से संबद्ध होता है जिसने उसे बनाया था: किसी दूसरे सत्र का एक्सेस टोकन `404` लौटाता है। 30 मिनट बीत जाने के बाद `pending` स्टेप-अप की स्थिति `expired` हो जाती है। ## OpenAPI ````yaml hi/openapi-authentication.json GET /step-up/{step_up_id}/ openapi: 3.0.3 info: title: Didit Authentication API version: 1.0.0 description: >- Didit Authentication के सर्वर-फेसिंग endpoints, जो आपके एप्लिकेशन के अंतिम उपयोगकर्ताओं के लिए साइन-इन उत्पाद है। Authentication **नया** है और 2026-11-01 रिलीज़ में प्रोडक्शन में पहुँचेगा। ## बेस URL प्रत्येक एप्लिकेशन अपना स्वयं का OpenID Connect issuer होता है, और नीचे दिया गया प्रत्येक endpoint उस issuer के रूट पर सर्व किया जाता है: - लाइव एप्लिकेशन के लिए `https://.auth.didit.me`, या सैंडबॉक्स एप्लिकेशन के लिए `https://.sandbox.auth.didit.me`। - आपका अपना कस्टम डोमेन, एक बार सक्रिय हो जाने के बाद। यह फिर डिफ़ॉल्ट होस्ट को issuer के रूप में बदल देता है: नए tokens इसे `iss` में नामित करते हैं, डिस्कवरी इसकी ओर इंगित करती है और पब्लिश करने योग्य कुंजी बदल जाती है। डिफ़ॉल्ट होस्ट के तहत जारी किए गए एक्सेस tokens रीफ़्रेश होने तक `/session/`, `/step-up/` और `/monitoring-token/` पर विफल हो जाते हैं। लाइव और सैंडबॉक्स अलग-अलग एप्लिकेशन हैं, इसलिए वे अलग-अलग कुंजियों वाले अलग-अलग issuers हैं। पब्लिश करने योग्य कुंजी `pk_live_` (लाइव) या `pk_test_` (सैंडबॉक्स) होती है, जिसके बाद बिना किसी ट्रेलिंग स्लैश के issuer का अनपैडेड base64url एन्कोडिंग होता है: issuer खोजने के लिए इसे डिकोड करें। यह एक सार्वजनिक पहचानकर्ता है, कोई क्रेडेंशियल नहीं। वही JSON endpoints `https://apx.didit.me/auth/v2/authentication/{application_id}/` के अंतर्गत भी सर्व किए जाते हैं। Tokens हमेशा उपरोक्त issuer का नाम देते हैं, चाहे उन्हें किसी भी पते ने जारी किया हो। ## क्रेडेंशियल्स ये endpoints कभी भी आपकी Didit API कुंजी या कंसोल token स्वीकार नहीं करते हैं। - डिस्कवरी, JWKS और `POST /token/` कोई क्रेडेंशियल नहीं लेते हैं। क्लाइंट सार्वजनिक होते हैं: कोई client secret नहीं होता है, और एक ऑथराइजेशन कोड अपने PKCE सत्यापनकर्ता (`S256`) से बंधा होता है। `client_id` आपकी एप्लिकेशन ID है। - `/session/`, `/step-up/` और `/monitoring-token/` व्यक्ति का एक्सेस token लेते हैं: `Authorization: Bearer `। प्रत्येक सफल कॉल को सत्र पर गतिविधि माना जाता है, इसलिए यह सत्र के निष्क्रिय टाइमआउट को पुनः आरंभ करता है। ## अनुरोध बॉडी बॉडी स्वीकार करने वाला प्रत्येक endpoint JSON, फ़ॉर्म-एन्कोडेड और मल्टीपार्ट बॉडी स्वीकार करता है। यह दस्तावेज़ JSON को सूचीबद्ध करता है, साथ ही `POST /token/` के लिए फ़ॉर्म-एन्कोडेड बॉडी को भी, जैसा कि OAuth क्लाइंट भेजते हैं। जो फ़ील्ड endpoint स्वीकार नहीं करता है, उस पर `400 {"": "unknown_field"}` मिलता है। ## Tokens - **Access token**: हेडर `typ: at+jwt` वाला एक ES256 JWT, जो अधिकतम 5 मिनट के लिए और कभी भी अपने सत्र से अधिक समय के लिए मान्य नहीं होता है। Claims: `AccessTokenClaims`। - **ID token**: हेडर `typ: JWT` वाला एक ES256 JWT। Claims: `IDTokenClaims`। इसे कभी भी एक्सेस token के रूप में स्वीकार नहीं किया जाता है। - **Refresh token**: एक रैंडम स्ट्रिंग जो प्रत्येक उपयोग पर रोटेट होती है। पहले से उपयोग किया गया रीफ़्रेश token दोबारा भेजने से सत्र रद्द हो जाता है। `GET /.well-known/jwks.json` से प्राप्त कुंजियों के साथ किसी token को सत्यापित करें: एल्गोरिदम `ES256` होना चाहिए, `typ` को token प्रकार से मेल खाना चाहिए, `iss` आपके द्वारा कॉन्फ़िगर किए गए issuer के बराबर होना चाहिए और `aud` आपकी एप्लिकेशन ID होनी चाहिए। ऑफ़लाइन सत्यापन किसी रद्द किए गए सत्र को केवल तभी देखता है जब उसका एक्सेस token समाप्त हो जाता है; `GET /session/` इसका त्वरित चेक है। ## त्रुटियाँ | बॉडी | कब | | --- | --- | | `{"error": ""}` | `POST /token/` से त्रुटियाँ, सभी स्टेटस `400` के साथ, [RFC 6749 section 5.2](https://www.rfc-editor.org/rfc/rfc6749#section-5.2) के बॉडी प्रारूप में: `invalid_grant`, `invalid_client` और Didit का `mfa_required`। सर्विस त्रुटियाँ: `temporarily_unavailable`, `monitoring_unavailable`, `monitoring_disabled`। | | `{"": [""]}` या `{"": ""}` | एक अनुरोध फ़ील्ड सत्यापन में विफल रहा। `non_field_errors` सभी फ़ील्ड्स में लागू नियम को इंगित करता है, और `unknown_field` उस फ़ील्ड को जिसे endpoint स्वीकार नहीं करता है। | | `{"detail": ""}` | `401` (`invalid_token`), `403` (`origin_not_allowed`), `404` (अज्ञात एप्लिकेशन या step-up) और `429` (रेट लिमिट)। साथ ही पार्स न की जा सकने वाली बॉडी के लिए `400` (`JSON parse error - ...`), endpoint द्वारा समर्थित न होने वाले मेथड के लिए `405` और असमर्थित `Content-Type` के लिए `415`। | `401` में `WWW-Authenticate: Bearer` भी शामिल होता है, और `429` में सेकंड में `Retry-After` शामिल होता है। दो अस्वीकृतियाँ JSON नहीं हैं। जो पता issuer नहीं है, उसे इन endpoints तक पहुँचने से पहले ही अस्वीकार कर दिया जाता है, उदाहरण के लिए किसी अप्रयुक्त `*.auth.didit.me` नाम के लिए रिक्त `404` के साथ। एक `step_up_id` जो UUID नहीं है, उसे एक `404` पेज मिलता है। ## रेट लिमिट एक अनुरोध को दो लेयर्स को पार करना होता है। **Endpoint सीमाएँ**, प्रति क्लाइंट IP पता, प्रति एप्लिकेशन और प्रति endpoint गिनी जाती हैं: - डिस्कवरी और JWKS: 1,200 अनुरोध प्रति मिनट और 12,000 प्रति घंटा। - अन्य प्रत्येक endpoint: 30 अनुरोध प्रति मिनट और 300 प्रति घंटा। `GET` और `DELETE /session/` एक ही गणना साझा करते हैं। सीमा पार होने पर: `429 {"detail": "Too many requests from this IP address. Please wait before trying again. Expected available in 60 seconds."}`, या प्रति घंटा सीमा के लिए `3600 seconds`। **बॉट सुरक्षा**, प्रत्येक `POST` और `DELETE` पर। इसके बकेट एप्लिकेशन के सभी `POST` और `DELETE` अनुरोधों द्वारा साझा किए जाते हैं, जिसमें होस्ट किए गए साइन-इन चरण भी शामिल हैं, और यह लगातार रिफिल होते हैं: - 60 अनुरोध प्रति मिनट प्रति क्लाइंट IP पता। - 30 अनुरोध प्रति मिनट प्रति डिवाइस, उन अनुरोधों के लिए जो अपने डिवाइस की पहचान करते हैं, जैसा कि ब्राउज़र और नेटिव SDK करते हैं। - पूरे एप्लिकेशन के लिए 3,000 अनुरोध प्रति मिनट, प्रत्येक IP पते पर। Token रीफ़्रेश (`POST /token/` साथ में `grant_type=refresh_token`) इसके बजाय अपने स्वयं के बकेट का उपयोग करते हैं: पूरे एप्लिकेशन के लिए 6,000 प्रति मिनट। बकेट की सीमा पार होने पर: `429 {"detail": "rate_limited Expected available in N seconds."}` (N के 1 होने पर `1 second.`)। प्रति-IP बकेट सभी endpoints में फैला होता है, इसलिए एक पता जो token, step-up और साइन-आउट कॉल को मिलाता है, वह किसी भी endpoint सीमा तक पहुँचने से पहले ही इसे खाली कर सकता है। एप्लिकेशन बकेट एप्लिकेशन के प्रत्येक क्लाइंट की गणना करता है, जिसमें ब्राउज़र भी शामिल हैं। दोनों लेयर्स endpoint के चलने से पहले उत्तर देती हैं, इसलिए जिस अनुरोध को `429` मिला वह निष्पादित नहीं हुआ: `Retry-After` के बाद पुनः प्रयास करें, जिसमें रीफ़्रेश भी शामिल है। ## ब्राउज़र अनुरोध एक अनुरोध जिसमें `Origin` हेडर होता है, उसे एप्लिकेशन के अपने मूल या इसके अनुमत मूल में से किसी एक से आना चाहिए, अन्यथा इसे `403 origin_not_allowed` प्राप्त होता है। सर्वर-टू-सर्वर अनुरोध कोई `Origin` नहीं भेजते हैं। ## यहाँ क्या शामिल नहीं है ये रूट होस्टेड पेज, ब्राउज़र और नेटिव SDK और AI एजेंटों को सर्व करते हैं। वे सर्वर अनुबंध का हिस्सा नहीं हैं, और सर्वर SDK उन्हें कॉल नहीं करते हैं: - साइन-इन चरण: `POST /authorize/`, `POST /password/`, `/email/*`, `/phone/*`, `/password-reset/*`, `/passkeys/*`, `/mfa/*`, `/social/*` और `/protection/complete/`। - होस्टेड पेज और कॉलबैक: `/sign-in`, `/magic`, `/invite`, `/reset`, `/verify/`, `/sso/*`, `/wallet/callback/`, `/logo/` और `/.well-known/` के अंतर्गत नेटिव ऐप एसोसिएशन फ़ाइलें। - एजेंट एक्सेस: `/agents/*` और `/grants/`, जिसमें `GET /agents/session/` शामिल है, जो किसी AI एजेंट के एक्सेस token के लिए लाइव चेक है। एजेंट एक्सेस अनुबंध के इस संस्करण का हिस्सा नहीं है। - Authentication के लिए कंसोल प्रबंधन API, जो कंसोल सत्र लेता है। Authentication इवेंट्स अभी webhook के रूप में डिलीवर नहीं किए जाते हैं, इसलिए यह दस्तावेज़ किसी webhook को परिभाषित नहीं करता है। servers: - url: https://{issuer} description: 'आपकी एप्लिकेशन का जारीकर्ता: इसका साइन-इन मूल।' variables: issuer: default: your-app.auth.didit.me description: >- जारीकर्ता का होस्ट: `.auth.didit.me` (लाइव), `.sandbox.auth.didit.me` (सैंडबॉक्स) या आपका सक्रिय कस्टम डोमेन। security: [] tags: - name: Issuer description: टोकन सत्यापित करने के लिए डिस्कवरी और साइनिंग कीज़। - name: Tokens description: प्राधिकरण कोड और रीफ़्रेश ग्रांट। - name: Sessions description: एक्सेस token के पीछे के सत्र की जांच करें और उसे समाप्त करें। - name: Step-ups description: किसी संवेदनशील कार्रवाई से पहले सत्यापन। - name: Monitoring description: लेन-देन निगरानी इवेंट के लिए डिवाइस क्रेडेंशियल्स। paths: /step-up/{step_up_id}/: get: tags: - Step-ups summary: एक स्टेप-अप प्राप्त करें description: >- स्टेप-अप की वर्तमान स्थिति। इसे उसी सत्र के एक्सेस token के साथ कॉल करें जिसने स्टेप-अप बनाया था, और केवल तभी कार्रवाई करें जब `status` `approved` हो। operationId: authentication_retrieve_step_up parameters: - name: step_up_id in: path required: true description: >- `POST /step-up/` से प्राप्त `id`, आपके `return_to` पर `step_up` क्वेरी पैरामीटर भी। जो मान UUID नहीं है, उसे JSON नहीं बल्कि `404` पेज मिलता है। schema: type: string format: uuid example: 94efc2c3-ca84-42fe-900b-6fb61669a7a1 responses: '200': description: स्टेप-अप। headers: Cache-Control: description: 'हमेशा `no-store`: इस रिस्पॉन्स को कभी कैश न करें।' schema: type: string example: no-store Pragma: description: हमेशा `no-cache`। schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/StepUp' examples: Approved: summary: 'स्वीकृत: आगे बढ़ें' value: id: 94efc2c3-ca84-42fe-900b-6fb61669a7a1 rule: payout method: selfie status: approved level: liveness_face_match amount: '900.00' currency: USD created_at: '2026-10-17T10:41:14.894632Z' completed_at: '2026-10-17T10:43:02.118204Z' expires_at: '2026-10-17T11:11:14.894581Z' Pending: summary: अभी तक समाप्त नहीं हुआ value: id: 94efc2c3-ca84-42fe-900b-6fb61669a7a1 rule: payout method: selfie status: pending level: null amount: '900.00' currency: USD created_at: '2026-10-17T10:41:14.894632Z' completed_at: null expires_at: '2026-10-17T11:11:14.894581Z' '401': $ref: '#/components/responses/InvalidToken' '403': $ref: '#/components/responses/OriginNotAllowed' '404': description: >- इस ID वाला कोई स्टेप-अप इस सत्र से संबंधित नहीं है, या एप्लिकेशन अज्ञात है। headers: Cache-Control: description: 'हमेशा `no-store`: इस रिस्पॉन्स को कभी कैश न करें।' schema: type: string example: no-store Pragma: description: हमेशा `no-cache`। schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: StepUpNotFound: summary: अज्ञात स्टेप-अप value: detail: No VerificationCheck matches the given query. '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/TemporarilyUnavailable' security: - AccessToken: [] components: schemas: StepUp: type: object description: एक सत्यापन जिसे व्यक्ति को कार्रवाई से पहले पास करना होगा। required: - id - rule - method - status - level - amount - currency - created_at - completed_at - expires_at properties: id: type: string format: uuid example: 94efc2c3-ca84-42fe-900b-6fb61669a7a1 rule: type: string enum: - payout - device - bank - contact description: >- वह नियम जिसने इसका अनुरोध किया था। जब कई लागू होते हैं, तो सबसे मजबूत विधि वाला नियम। example: payout method: type: string enum: - liveness - selfie - full_id description: >- व्यक्ति क्या करता है: `liveness`, `selfie` (Didit के पास पहले से मौजूद चेहरे से मेल खाने वाली लाइवनेस) या `full_id` (दस्तावेज़ और सेल्फ़ी)। जब Didit के पास उस व्यक्ति का कोई चेहरा मौजूद नहीं होता है, तो उनके द्वारा `verification_url` खोलने पर `selfie` बदलकर `full_id` हो जाता है। example: selfie status: type: string enum: - pending - review - approved - declined - expired - superseded description: >- केवल `approved` पर कार्रवाई करें। `review` आपकी टीम की समीक्षा की प्रतीक्षा करता है। जब तक `verification_url` काम कर रहा है, `declined` अंतिम नहीं है: व्यक्ति पुनः प्रयास कर सकता है, और स्टेप-अप `pending` पर वापस आ जाता है। `superseded` का अर्थ है कि किसी अन्य जांच ने इसके सत्यापन का कार्यभार संभाल लिया है, या परिणाम इस स्टेप-अप के लिए नहीं था: एक नया बनाएं। example: pending level: type: string nullable: true enum: - liveness - liveness_face_match - full_id - null description: एक बार स्वीकृत होने के बाद, सत्यापन जिस स्तर तक पहुँचा। example: null amount: type: string nullable: true description: पेआउट राशि, दो दशमलव स्थान। example: '900.00' currency: type: string nullable: true example: USD created_at: type: string format: date-time example: '2026-10-17T10:41:14.894632Z' completed_at: type: string format: date-time nullable: true example: null expires_at: type: string format: date-time description: >- निर्माण के 30 मिनट बाद। स्टेप-अप को पढ़ने पर पहले कोई भी परिणाम एकत्र किया जाता है जिस तक इसका सत्यापन पहुंचा था, इसलिए यह इस समय के बाद भी `approved`, `review` या `declined` पढ़ सकता है; जो अभी भी `pending` है वह `expired` पढ़ता है। example: '2026-10-17T11:11:14.894581Z' Detail: type: object required: - detail properties: detail: type: string example: invalid_token OAuthError: title: OAuth error type: object description: एक OAuth त्रुटि (RFC 6749 धारा 5.2) या एक सेवा त्रुटि। required: - error properties: error: type: string example: invalid_grant responses: InvalidToken: description: >- एक्सेस token अनुपस्थित, विकृत, समय-सीमा समाप्त, किसी अन्य जारीकर्ता या कुंजी द्वारा हस्ताक्षरित, एक ID token, एक एजेंट token है, या रीफ़्रेश द्वारा प्रतिस्थापित किया गया है; या इसका सत्र निरस्त कर दिया गया था, निष्क्रिय हो गया था, अपनी जीवन अवधि पार कर चुका था या अब आपकी MFA नीति को पूरा नहीं करता है, या इसके व्यक्ति को ब्लॉक कर दिया गया था या उनका ईमेल अब सत्यापित नहीं है। व्यक्ति को फिर से साइन-इन के माध्यम से भेजें। headers: WWW-Authenticate: description: '`Bearer`।' schema: type: string example: Bearer Cache-Control: description: 'हमेशा `no-store`: इस रिस्पॉन्स को कभी कैश न करें।' schema: type: string example: no-store Pragma: description: हमेशा `no-cache`। schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: InvalidToken: summary: अस्वीकृत एक्सेस टोकन value: detail: invalid_token OriginNotAllowed: description: >- अनुरोध में एक ऐसा `Origin` था जो न तो एप्लिकेशन का अपना है और न ही इसके स्वीकृत ओरिजिन में है। सर्वर अनुरोध कोई `Origin` नहीं भेजते हैं। headers: Cache-Control: description: 'हमेशा `no-store`: इस रिस्पॉन्स को कभी कैश न करें।' schema: type: string example: no-store Pragma: description: हमेशा `no-cache`। schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: OriginNotAllowed: summary: ऑरिजिन की अनुमति नहीं है value: detail: origin_not_allowed RateLimited: description: >- इस endpoint के लिए इस IP पते से बहुत सारे अनुरोध आए हैं, या `POST` या `DELETE` पर बॉट सुरक्षा बकेट खाली है। कुछ भी निष्पादित नहीं हुआ: `Retry-After` सेकंड प्रतीक्षा करें, फिर पुनः प्रयास करें। headers: Retry-After: description: पुनः प्रयास करने से पहले प्रतीक्षा करने के सेकंड। schema: type: integer example: 60 Cache-Control: description: 'हमेशा `no-store`: इस रिस्पॉन्स को कभी कैश न करें।' schema: type: string example: no-store Pragma: description: हमेशा `no-cache`। schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: RateLimited: summary: Endpoint सीमा value: detail: >- Too many requests from this IP address. Please wait before trying again. Expected available in 60 seconds. BotProtection: summary: बॉट सुरक्षा सीमा (POST और DELETE) value: detail: rate_limited Expected available in 2 seconds. TemporarilyUnavailable: description: >- अनुरोध जिस सेवा पर निर्भर करता है वह कुछ समय के लिए अनुपलब्ध है। बैकऑफ़ के साथ पुनः प्रयास करें। headers: Cache-Control: description: 'हमेशा `no-store`: इस रिस्पॉन्स को कभी कैश न करें।' schema: type: string example: no-store Pragma: description: हमेशा `no-cache`। schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/OAuthError' examples: TemporarilyUnavailable: summary: बाद में पुनः प्रयास करें value: error: temporarily_unavailable securitySchemes: AccessToken: type: http scheme: bearer bearerFormat: JWT description: >- `POST /token/` से व्यक्ति का एक्सेस token: हेडर `typ: at+jwt` वाला एक ES256 JWT, जो अधिकतम 5 मिनट के लिए मान्य है। यह आपकी Didit API कुंजी नहीं है। ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.