> ## 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.

# الحصول على رابط بنكي عبر API: الحالة ومعرّف الاتصال

> تُرجع نقطة endpoint في Didit للحصول على رابط بنكي حالة الرابط، وبعد اكتماله، connection_id وcheck_id الخاصين به.

تُعيد endpoint Get a Bank Link من Didit حالة الرابط، وبعد اكتماله تُعيد أيضًا `connection_id` و`check_id` الخاصين به.
استدعها من الخادم بعد `onSuccess` أو عند `bank.link.completed`، ولا تثق أبدًا بمعرّف الرابط المُرسل من المتصفح.
يُرجع الرابط الفاشل الاستجابة `200` مع `status: failed` وخطأً في `error` بكود مثل `duplicate_conflict` أو `reduced_grant`.


## OpenAPI

````yaml ar/openapi-25.json GET /v3/bank/links/{id}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: واجهة برمجة تطبيقات التحقق من الهوية. صادِق باستخدام الترويسة x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link والاتصالات والحسابات والأرصدة والمعاملات والمؤسسات والتغطية.
      بيانات البنك متاحة للتطبيقات التجريبية. ترد استدعاءات التطبيق الحي بـ
      `404` إلى أن يُعلن الوصول الحي. لا تُحتسب أي رسوم في البيئة التجريبية.
      يحتاج الاستدعاء الذي يتم بمفتاح API إلى مفتاح يتضمن إذن بيانات البنك
      (`bank-data`): القراءة للقراءات، والكتابة للعمليات التي تغيّر شيئاً. فحص
      الحساب هو الاستثناء: يحتاج إلى صلاحية الكتابة على الجلسات، أو الوصول
      الكامل، وليس إذن بيانات البنك. بيانات البنك غير مشمولة بالوصول الكامل:
      يُرفض مفتاح الوصول الكامل، ويرد الاستدعاء بـ `403 bank_data_access_denied`
      إلى أن تنشئ مفتاحاً يتضمن الإذن. ترفض بيانات البنك الخام (الحسابات
      والأرصدة والمعاملات وموجز التغييرات) أيضاً الطلب الذي لا يتضمن مفتاح API.


      تحمل كل حالات الرفض ضمن `/v3/bank/`، باستثناء رفض فحص الحساب، جسم JSON
      نفسه (`code`، `message`، `request_id`، `field`، `next_action`،
      `retry_after`). يرد مسار ليس عملية، أو معرّف ليس UUID، أو مورد فرعي غير
      معروف، بـ `404 not_found` لكل طريقة، ويرد أي خطأ غير متوقع بـ `500
      internal_error` مع `request_id`. حيثما لا تكون بيانات البنك متاحة، ترد كل
      عملية بـ `404` القياسي للمنصة، تماماً كما يرد المسار غير المعروف.
paths:
  /v3/bank/links/{id}/:
    get:
      tags:
        - Bank Data
      summary: الحصول على رابط بنكي
      description: >-
        يُرجع حالة الرابط، وبعد أن يصبح `completed` يُرجع أيضاً `connection_id`
        و`check_id`. هذه هي الإجابة المعتمدة: استدعِه من خادمك بعد أن يُبلغ
        المتصفح عن النجاح، أو عند حدث `bank.link.completed` في webhook.


        الرابط الذي يفشل لا يُعيد خطأ HTTP: يُعاد برمز `200` مع `status: failed`
        وكائن `error`، مثل `duplicate_conflict` مع `conflicts_with`. لا يُعاد
        `url` و`client_token` إلا عند إنشاء الرابط.


        يتطلب مفتاح API بصلاحية بيانات البنك (`bank-data`): قراءة لهذه العملية.
        لا يشمل المفتاح ذو الوصول الكامل هذه الصلاحية: امنحها صراحةً عند إنشاء
        المفتاح، وإلا أعاد الاستدعاء `403 bank_data_access_denied`.
      operationId: getBankLink
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: معرّف الرابط.
      responses:
        '200':
          description: الرابط.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankLink'
              examples:
                Completed:
                  summary: رابط مكتمل
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: completed
                    url: null
                    client_token: null
                    expires_at: '2026-11-21T13:00:00Z'
                    connection_id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    check_id: null
                    reused: false
                    error: null
                    quote:
                      id: 7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43
                      lines:
                        - meter: bank_data_connection_month
                          unit: connection_month
                          price_usd: '0.9000'
                      fallback_lines: null
                      total_usd: '0.9000'
                      valid_until: '2026-11-21T13:00:00Z'
                      scopes:
                        - accounts
                        - balances
                        - transactions
                    vendor_data: client-7731
                Failed with a duplicate:
                  summary: رابط فشل لأن الشخص يشارك هذه الحسابات مسبقاً
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: failed
                    url: null
                    client_token: null
                    expires_at: '2026-11-21T13:00:00Z'
                    connection_id: null
                    check_id: null
                    reused: false
                    error:
                      code: duplicate_conflict
                      message: >-
                        The person already shares some of these accounts through
                        another connection.
                      conflicts_with:
                        - 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    quote:
                      id: 7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43
                      lines:
                        - meter: bank_data_connection_month
                          unit: connection_month
                          price_usd: '0.9000'
                      fallback_lines: null
                      total_usd: '0.9000'
                      valid_until: '2026-11-21T13:00:00Z'
                      scopes:
                        - accounts
                        - balances
                        - transactions
                    vendor_data: client-7731
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: المورد غير موجود في هذا التطبيق وهذه البيئة.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: غير موجود
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/links/0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.get_link(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.bank.getLink("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.GetLink(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.bank().getLink("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->bank->getLink('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.bank.get_link("11111111-2222-3333-4444-555555555555")
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Bank.GetLinkAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankLink:
      type: object
      description: >-
        تشغيل واحد لـ Bank Link لشخص واحد: ربط بنك، أو تجديد ربط. أكِّد الرابط
        بنفسك باستخدام `get_link`، ولا تثق أبداً بمعرّف يرسله المتصفح.
      properties:
        id:
          type: string
          description: معرّف الرابط.
          format: uuid
        mode:
          type: string
          enum:
            - connect
            - renew
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - created
            - opened
            - connecting
            - completed
            - cancelled
            - expired
            - failed
          description: >-
            حالة الرابط. الحالات `completed` و`cancelled` و`expired` و`failed`
            نهائية.
        url:
          type: string
          description: >-
            صفحة التحقق المستضافة التي يُوجَّه إليها الشخص. تُعاد فقط عند إنشاء
            الرابط؛ وتكون `null` في القراءات اللاحقة لأن الرمز لا يُخزَّن.
          nullable: true
          format: uri
        client_token:
          type: string
          description: >-
            token الخاص بـ Bank Link المضمّن في Didit، وهو غير متاح بعد: افتح
            `url` حالياً. يُعاد عند إنشاء الرابط فقط، وتكون القيمة `null` في
            القراءات اللاحقة. له غرض واحد وصلاحية قصيرة، ولا يحمل أي بيانات
            شخصية. لا تسجّله في السجلات أبداً.
          nullable: true
        expires_at:
          type: string
          description: متى يتوقف الرابط غير المستخدَم عن العمل.
          format: date-time
        connection_id:
          type: string
          description: >-
            الاتصال الذي أنشأه هذا الرابط أو جدّده، بمجرد أن تصبح `status` بقيمة
            `completed`.
          format: uuid
          nullable: true
        check_id:
          type: string
          description: >-
            نتيجة الملكية لهذا الرابط، عندما يطلب `ownership.compare` بقيمة غير
            `none`.
          format: uuid
          nullable: true
        reused:
          type: boolean
          description: >-
            `true` عندما يكتمل الرابط بوصفه تجديداً لاتصال قائم، لأن الشخص يشارك
            بالفعل هذه الحسابات نفسها بالضبط (`duplicates: reuse`). لا تُفرض أي
            رسوم مرتين.
        error:
          allOf:
            - $ref: '#/components/schemas/BankLinkError'
          nullable: true
          description: >-
            سبب فشل الرابط، عندما تكون `status` هي `failed`. وإلا فالقيمة
            `null`.
        quote:
          $ref: '#/components/schemas/BankLinkQuote'
        vendor_data:
          type: string
          description: مرجعك من الطلب.
          nullable: true
      required:
        - id
        - mode
        - access
        - status
        - url
        - client_token
        - expires_at
        - connection_id
        - check_id
        - reused
        - error
        - quote
        - vendor_data
    BankDataError:
      type: object
      description: جسم الخطأ لكل عملية من عمليات بيانات البنك. جميع الحقول موجودة دائماً.
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            رمز الخطأ بصيغة يمكن للآلة قراءتها. اعتمد على هذا الرمز في التفريع،
            ولا تعتمد على `message` أبداً.
        message:
          type: string
          description: شرح بلغة بسيطة للمطوّر. قد تتغير الصياغة؛ لا تحلّلها برمجياً.
        request_id:
          type: string
          description: معرّف هذا الطلب. اذكره عند التواصل مع الدعم.
        field:
          type: string
          description: >-
            حقل الطلب المطلوب تصحيحه، إذا كان الخطأ متعلقاً بحقل واحد. وإلا
            فتكون القيمة `null`.
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            ما الذي ينبغي فعله تاليًا، حتى يتمكن العميل من التصرف دون تخمين.
            القيمة `null` عندما لا توجد خطوة تالية قياسية.
          nullable: true
        retry_after:
          type: integer
          description: >-
            عدد الثواني التي تنتظرها قبل إعادة المحاولة. يُضبط عند أخطاء حد
            المعدل والأخطاء المؤقتة، وإلا فهو `null`.
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    BankLinkError:
      type: object
      description: سبب انتهاء الرابط بالحالة `failed`. لم يُنشر أي شيء ولم تُحتسب أي رسوم.
      properties:
        code:
          type: string
          enum:
            - duplicate_conflict
            - renewal_login_mismatch
            - reduced_grant
            - corporate_approval_not_supported
            - ongoing_access_not_available
            - bank_unavailable
            - bank_cancelled
            - consent_declined
            - read_limit
            - renewal_not_needed
            - renewal_window_expired
            - first_sync_failed
          description: >-
            سبب فشل الرابط. الرابط الفاشل ليس خطأ HTTP: يُقرأ الرابط بالحالة
            `status: failed` وبهذا الكائن. رابط التجديد الذي تغيّر فيه الاتصال
            في هذه الأثناء يُقرأ بالقيمة `renewal_not_needed` أو
            `renewal_window_expired`.
        message:
          type: string
          description: شرح بلغة بسيطة للمطوّر.
        conflicts_with:
          type: array
          nullable: true
          items:
            type: string
            format: uuid
          description: >-
            مع `duplicate_conflict`: معرّفات الاتصالات النشطة المتداخلة. جدّد
            أحدها، أو أنشئ الرابط مرة أخرى مع `duplicates: allow`.
      required:
        - code
        - message
        - conflicts_with
    BankLinkQuote:
      type: object
      description: >-
        سعر الرابط، ويُثبَّت عند إنشائه. يُحتسب الرسم وفق عرض السعر. لا تُحتسب
        أي رسوم عند عمليات القراءة.
      properties:
        id:
          type: string
          description: معرّف عرض السعر.
          format: uuid
        lines:
          type: array
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: بنود الرسوم التي يفرضها هذا الرابط، وفق النطاقات التي يطلبها.
        fallback_lines:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            تكلفة الخيار الاحتياطي لمرة واحدة، وتظهر فقط إذا أُنشئ الرابط بـ
            `allow_one_time_fallback`. تظهر في استجابة الإنشاء وتكون القيمة
            `null` في غير ذلك. قد تكلّف القراءة لمرة واحدة مع البيانات أكثر من
            الشهر الأول من الوصول المستمر.
        total_usd:
          type: string
          description: >-
            مجموع `lines` بالدولار الأمريكي. لا يرتفع المجموع أبداً، ويمكن أن
            ينخفض فقط: مع منحة مخفّضة، أو عندما يختار الشخص دولة ذات سعر أقل.
          pattern: ^-?\d+(\.\d+)?$
        valid_until:
          type: string
          description: >-
            يرتبط عرض السعر بالرابط ويبقى صالحاً طوال مدة صلاحيته، لذلك يساوي
            `expires_at`.
          format: date-time
        scopes:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: تحدد البيانات نطاق أسعار عرض السعر.
      required:
        - id
        - lines
        - fallback_lines
        - total_usd
        - valid_until
        - scopes
    RateLimitBudgetError:
      type: object
      description: >-
        تُرجع فقط عند رفض ميزانية وسيط تحديد المعدل. أخطاء 429 الأخرى، بما في
        ذلك تعارضات idempotency والحدود الخاصة بنقطة النهاية، لا تضمن هذه الحقول
        الوصفية.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: رسالة رفض الميزانية الحالية المقروءة للإنسان.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            مرجع الدعم المعتم: RL- متبوعة بـ 32 حرفًا سداسيًا عشريًا صغيرًا من
            UUID.
        limit:
          type: integer
          description: الميزانية للنطاق الذي تجاوز الحد؛ تساوي X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            الميزانية المتبقية، محدودة بحيث لا تقل عن الصفر؛ تساوي
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            وقت إعادة تعيين النافذة بالثواني منذ حقبة Unix، ويساوي
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            مدة النافذة الثابتة بالثواني، وليست الفترة المتبقية للانتظار. يجب
            احترام Retry-After قبل إعادة المحاولة.
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
    BankLinkQuoteLine:
      type: object
      description: بند مُسعَّر واحد في عرض السعر.
      properties:
        meter:
          type: string
          description: >-
            ما الذي يُحتسب عليه، على سبيل المثال `bank_data_connection_month`
            و`bank_verification`.
          example: bank_data_connection_month
        unit:
          type: string
          description: >-
            ما هي الوحدة الواحدة، على سبيل المثال `connection_month` أو
            `completed_sign_in`.
          example: connection_month
        price_usd:
          type: string
          description: >-
            سعر الوحدة الواحدة بالدولار الأمريكي، سلسلة عشرية بأربع خانات عشرية.
            المبالغ في الأمثلة توضيحية؛ يظهر سعر كل دولة في صفحة الأسعار.
          pattern: ^-?\d+(\.\d+)?$
          example: '0.9000'
      required:
        - meter
        - unit
        - price_usd
  responses:
    Unauthorized:
      description: غير مُصرَّح به
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: مفتاح API غير صالح
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        لا يملك مفتاح API صلاحية بيانات البنك (`bank-data`)، أو، بالنسبة
        للبيانات الخام في تطبيق إنتاجي، يكون الإعداد "Bank data in the API"
        متوقفا. بيانات البنك ليست جزءا من الوصول الكامل: يُرفض بهذا النص مفتاح
        الوصول الكامل، ومفتاح مقيّد بموارد أخرى، وطلب مصادق عليه دون مفتاح API
        (بيانات اعتماد العميل عند طلب البيانات الخام)، لذا أنشئ مفتاحا وامنحه
        الصلاحية صراحة. يحدث الرفض قبل أي بحث، لذا لا يدل على وجود الكائن أو
        عدمه.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: بيانات البنك غير مسموح بها
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedRead:
      description: >-
        تجاوزت ميزانية القراءة الخاصة بالوسيط. التزم بالرأس Retry-After قبل
        إعادة المحاولة.
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        حدث خطأ من جهة Didit. أي خطأ غير متوقع تحت `/v3/bank/` يُعاد بصيغة خطأ
        Bank، وليس بصفحة HTML أبداً: أرفق `request_id` عند التواصل مع الدعم.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: خطأ غير متوقع
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        عدد الثواني للانتظار، مقرّباً إلى أعلى حتى بداية النافذة التالية. يظهر
        في حالات رفض ميزانية الوسيط.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: النطاق الذي تجاوز ميزانيته. يظهر في حالات رفض ميزانية الوسيط.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        الميزانية المخصصة للنطاق الذي تم تجاوزه؛ وتساوي حد جسم الطلب. تظهر في
        حالات الرفض الصادرة عن ميزانية البرمجية الوسيطة.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        الميزانية المتبقية، محدودة بحيث لا تقل عن الصفر؛ تساوي remaining في
        الجسم. تظهر في حالات رفض الميزانية من الوسيط.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        وقت إعادة التعيين بالثواني منذ حقبة Unix؛ يساوي قيمة reset في جسم
        الاستجابة. يظهر في حالات رفض ميزانية الوسيط.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        مفتاح API الخاص بتطبيقك، ويمكن الحصول عليه من Developers -> API keys في
        Business Console. يملك المفتاح الأساسي صلاحية وصول كاملة. يمكن تقييد
        المفتاح المسمّى: بلا صلاحية، أو قراءة، أو كتابة لكل مورد، ويمكن قصره على
        بعض سير العمل أو على الجلسات المعتمدة، وعلى قائمة من عناوين IP، وعلى
        تاريخ انتهاء. يعني الرمز 401 أن المفتاح غير صحيح أو ملغى أو منتهي
        الصلاحية. ويعني الرمز 403 أنه لم يُرسل أي مفتاح، أو أن المفتاح لا يملك
        صلاحية لهذا المورد أو الإجراء، أو أن الطلب صدر من عنوان خارج قائمة IP
        الخاصة به. ويعني الرمز 404 على مسار جلسة أن الجلسة خارج سير عمل المفتاح
        أو حالاته المسموح بها. يتلقى المفتاح الذي لا يملك وصولًا إلى الوسائط
        عناوين URL للصور والفيديو وملفات PDF بقيمة null، ويتلقى المفتاح الذي لا
        يملك صلاحية كتابة الجلسات روابط الجلسات والرموز بقيمة null. راجع
        https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.