> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# الحصول على إجماع الشهود

> استرداد نتيجة الإجماع لطلب التحقق من الشاهد

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

يتم حساب الإجماع تلقائيًا عندما يصل عدد الشهادات إلى عتبة `required_witnesses`. تحدد أغلبية بسيطة من أحكام `confirm` أو `deny` النتيجة. تُحتسب أصوات `abstain` ضمن النصاب القانوني ولكنها لا تؤثر على حساب الأغلبية.

### المصادقة

يتطلب رأس `X-API-Key` أو رمز Bearer JWT. يتم اشتقاق مساحة العمل من بيانات الاعتماد الموثقة؛ لا ترسل `X-Tenant-ID`.

### الاستجابة

**id** `string`

معرف طلب الشاهد.

**claim\_id** `string`

ادعاء الحقيقة الذي كان يتم الشهادة عليه.

**status** `string`

الحالة الحالية لطلب الشاهد. أحد الخيارات: - `pending` -- لا يزال ينتظر
الشهادات - `confirmed` -- تم التوصل إلى توافق، وتم تأكيد المطالبة - `denied`
\-- تم التوصل إلى توافق، تم رفض المطالبة - `expired` -- انقضى TTL بدون
الوصول إلى النصاب القانوني

**required\_witnesses** `integer`

عدد الإثباتات المطلوبة للإجماع.

**confirmations** `integer`

عدد أحكام `confirm` المستلمة.

**denials** `integer`

عدد أحكام `deny` المستلمة.

**abstentions** `integer`

عدد أحكام `abstain` المستلمة.

**consensus\_reached** `boolean`

ما إذا كان النصاب القانوني المطلوب قد اكتمل وتم اتخاذ قرار.

**consensus\_at** `string`

طابع زمني ISO 8601 عندما تم التوصل إلى توافق. `null` إذا كان لا يزال معلقًا أو
انتهت صلاحيته دون توافق.

**expires\_at** `string`

طابع زمني ISO 8601 لتاريخ انتهاء صلاحية طلب الشاهد (أو انتهى).

### منطق الإجماع

| السيناريو | النتيجة |
| :- | :- |
| تم تحقيق النصاب، أغلبية `confirm` | `confirmed` |
| تم تحقيق النصاب، أغلبية `deny` | `denied` |
| تم تحقيق النصاب، متساوٍ `confirm`/`deny` | مرجح حسب درجات الثقة؛ أعلى ثقة إجمالية تفوز |
| تنتهي صلاحية TTL قبل النصاب | `expired` |


## OpenAPI

````yaml ar/mint-openapi.yaml GET /v1/witness/{witnessRequestID}/consensus
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks هي بنية تحتية عالمية للتحقق من المستندات وبيانات الاعتماد والأصول
    الرقمية.يحدد هذا المواصفات واجهة برمجة التطبيقات (API) الأساسية للتفاعل مع
    خدمات Truthlocks.


    ## عناوين URL الأساسية

    - **الإنتاج**: `https://api.truthlocks.com`

    - **البيئة التجريبية (Sandbox)**: `https://sandbox-api.truthlocks.com`


    ## المصادقة

    - **مفاتيح API**: استخدم رأس `X-API-Key` للعمليات من جهاز إلى جهاز

    - **رموز Bearer**: استخدم `Authorization: Bearer <jwt>` للعمليات التي يبدأها
    المستخدم


    ## هوية المستأجر

    في بيئة الإنتاج، تُستمد هوية المستأجر من السياق المصادق عليه (مفتاح API أو
    JWT).

    يتم تجاهل رأس `X-Tenant-ID` في بيئة الإنتاج لمنع الانتحال.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: واجهة برمجة تطبيقات الإنتاج
  - url: https://sandbox-api.truthlocks.com
    description: بيئة اختبار (Sandbox)
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: إدارة مفاتيح ورموز API
  - name: Issuers
    description: تسجيل المصدر وإدارة الثقة
  - name: Keys
    description: إدارة المفاتيح التشفيرية لجهات الإصدار
  - name: Attestations
    description: دورة حياة الإشهاد (السك، الإلغاء، الاستبدال)
  - name: Verification
    description: حزم التحقق والإثبات للإشهاد
  - name: Governance
    description: سير عمل حوكمة المصدر (للمسؤول فقط)
  - name: Identity
    description: إدارة المنظمة والمستخدمين والأدوار
  - name: Audit
    description: استعلامات أحداث التدقيق
  - name: Tenant Console
    description: ملف تعريف المستأجر ونقاط نهاية دورة الحياة
  - name: Health
    description: نقاط نهاية صحة الخدمة وجاهزيتها
  - name: Risk
    description: استيعاب إشارة المخاطر واكتشاف الاحتيال
  - name: Risk Enforcement
    description: إجراءات إنفاذ المخاطر — الحظر والتحدي والحجر والتكوين
  - name: Billing
    description: إدارة الفوترة والاشتراكات والإضافات
  - name: Machine Identity
    description: >-
      بروتوكول هوية وكيل الآلة (MAIP) — تسجيل الوكيل، الجلسات، الثقة، الشهادة،
      الامتثال، التنسيق، والمراقبة
externalDocs:
  description: واجهة برمجة تطبيقات الشفافية للقراءة فقط (مواصفات خدمة منفصلة)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/witness/{witnessRequestID}/consensus:
    get:
      tags:
        - Machine Identity
      summary: التحقق من الإجماع
      description: >
        يتحقق مما إذا كانت مجموعة الشهود قد وصلت إلى الحد الأدنى المطلوب من
        التصديق.

        يعيد عدد التصديقات الحالي والتوقيعات المجمعة.
      operationId: maip.witness.consensus
      parameters:
        - name: witnessRequestID
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: معرف مجموعة الشهود
      responses:
        '200':
          description: حالة الإجماع
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipConsensus'
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: لم يتم العثور على مجموعة شهود
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: تجاوز حد المعدل
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    MaipConsensus:
      type: object
      properties:
        reached:
          type: boolean
        attestation_count:
          type: integer
        required:
          type: integer
        signatures:
          type: array
          items:
            type: string
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: رمز خطأ قابل للقراءة آليًا
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: رسالة خطأ مقروءة بشريًا
        http_status:
          type: integer
          description: رمز حالة HTTP
        retry_after_ms:
          type: integer
          description: عدد المللي ثانية للانتظار قبل إعادة المحاولة (لحدود المعدل)
        details:
          type: object
          description: سياق خطأ إضافي
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: مفتاح API للمصادقة من جهاز إلى جهاز
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT للعمليات التي يبدأها المستخدم

````

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