> ## 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: التحقق من الشركات (KYB) > استرجاع شركة واحدة في Didit (KYB) عبر vendor_data مع هويتها المستمدة من السجل وحالتها وعدادات KYB المجمّعة وخريطة الميزات. الدفع لكل استدعاء. موجّه الحصول على الشركة نسخ الموجّه إلى الحافظة \

\`Goal: Fetch a single Didit Business (KYB) entity by your own vendor_data.

Endpoint: GET https://verification.didit.me/v3/businesses/{vendor_data}/
Auth header: x-api-key: 

Path param:
\- vendor_data (string, REQUIRED) — your unique identifier. Free-form string, NOT a UUID. Matching is case-insensitive after normalisation. URL-encode it.

curl:
curl -X GET 'https://verification.didit.me/v3/businesses/company-123/' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (BusinessDetailItem) — extends the list shape with metadata, comments (activity log), and updated_at. Key fields:
\- didit_internal_id (UUID — Didit's stable internal identifier)
\- vendor_data (string)
\- display_name, legal_name, registration_number, country_code, region, effective_name
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices)
\- session_count, approved_count, declined_count, in_review_count (aggregate counters)
\- features (map: KYB_REGISTRY, KYB_AML, KYB_DOCUMENTS, ... -> latest status)
\- metadata (arbitrary JSON you attached)
\- comments (chronological activity log)
\- tags, created_at, updated_at, last_activity_at
See /reference/data-models for the full schema.

Notes:
\- Aggregate counters update in real time as Business Verification (KYB) sessions reach terminal status.
\- Registry-derived fields reflect the latest approved KYB session's registry data.
\- For bulk lookups, prefer paging GET /v3/businesses/ and indexing locally on vendor_data.

Failure modes (envelope {"detail": "..."}):
\- 401 — missing/invalid x-api-key.
\- 403 — lacks read:businesses.
\- 404 — no business with that vendor_data in this application.
\- 429 — rate-limited.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
الصق في ## نظرة عامةيُرجع كيان شركة واحدًا من [كيان الشركة](https://docs.didit.me/ar/entities/businesses/overview.md) مفهرسًا بواسطة `vendor_data`.## متى تستخدمه- **البحث عن** حالة التحقق الحالية لشركة: يمنحك مخطط `features` أحدث حالة لكل ميزة من ميزات التحقق من الشركات (KYB) في نظرة واحدة. - **عروض التفاصيل** في واجهة الإدارة الخاصة بك. - **تقييم المخاطر** باستخدام العدادات الإجمالية وحالات الميزات.## ملاحظات- قيمة `vendor_data` في عنوان URL حساسة لحالة الأحرف. - يُرجع `404` إذا لم توجد شركة بقيمة `vendor_data` هذه. - تتحدّث العدادات الإجمالية (`session_count` و`approved_count` و`declined_count` و`in_review_count`) في الوقت الفعلي عند اكتمال جلسات التحقق من الشركات (KYB). - تعكس الحقول المستمدة من السجل (`legal_name` و`registration_number` و`country_code`) آخر جلسة تحقق من الشركات (KYB) مقبولة.## الأذوناتيجب أن يمنح الدور صلاحية `read:businesses`.## ذات صلة- [نظرة عامة على الشركات](https://docs.didit.me/ar/entities/businesses/overview.md) - [نموذج البيانات](https://docs.didit.me/ar/entities/businesses/data-model.md) - [عرض الشركات](https://docs.didit.me/ar/management-api/businesses/list.md) ## OpenAPI ````yaml ar/openapi-25.json GET /v3/businesses/{vendor_data}/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API التحقق من الهوية. قم بالمصادقة باستخدام الرأس x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/businesses/{vendor_data}/: get: tags: - Businesses summary: الحصول على الشركة description: >- جلب [شركة](/entities/businesses) واحدة عبر `vendor_data` (تطابق تام). يضيف `metadata` و`updated_at` إلى عرض القائمة. الشركات المحذوفة تُرجع 404. operationId: get_business parameters: - name: vendor_data in: path required: true schema: type: string description: >- معرّفك الفريد للشركة — سلسلة نصية حرة (وليس UUID)، وتتم مطابقته تماماً كما أُرسل. example: company-123 responses: '200': description: >- تفاصيل الشركة الكاملة بما في ذلك البيانات الوصفية وبيانات الجلسة المجمعة. content: application/json: schema: $ref: '#/components/schemas/BusinessDetailItem' examples: Active business: value: didit_internal_id: a1b2c3d4-e5f6-4890-abcd-ef1234567890 vendor_data: company-123 display_name: null legal_name: Acme Trading Ltd registration_number: '12345678' country_code: GB effective_name: Acme Trading Ltd status: ACTIVE session_count: 2 approved_count: 1 declined_count: 0 in_review_count: 1 features: KYB: Approved features_list: - feature: KYB status: Approved last_session_at: '2026-03-15T10:30:00Z' last_activity_at: '2026-03-15T10:30:00Z' first_session_at: '2026-01-10T08:00:00Z' tags: - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d name: VIP color: '#2567FF' created_at: '2026-01-10T08:00:00Z' metadata: industry: fintech updated_at: '2026-03-15T10:30:00Z' '403': description: >- مفتاح API مفقود أو غير صالح أو ملغى، أو لا يمكن للمفتاح قراءة شركات هذا التطبيق. يعيد المفتاح المفقود `403`؛ بينما يعيد المفتاح الخاطئ أو الملغى أو منتهي الصلاحية `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '404': description: >- لا توجد شركة (غير محذوفة) ببيانات `vendor_data` المقدمة لهذا التطبيق. content: application/json: examples: Not found: value: detail: Not found. '429': description: >- تم تجاوز حد المعدل؛ تراجع مؤقتاً وأعد المحاولة بعد الفاصل الزمني الموضح في `Retry-After`. content: application/json: examples: Rate limited: value: detail: Request was throttled. Expected available in 30 seconds. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/businesses/company-123/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.businesses.retrieve( "company-123", ) 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.businesses.retrieve("company-123"); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Retrieve(ctx, \"company-123\")\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.businesses().retrieve("company-123"); System.out.println(result); - lang: php label: PHP source: |- businesses->retrieve('company-123'); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.businesses.retrieve("company-123") 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.Businesses.RetrieveAsync("company-123"); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: BusinessDetailItem: type: object description: >- تفاصيل الشركة الكاملة. يمتد من BusinessListItem بإضافة البيانات الوصفية وupdated_at. allOf: - $ref: '#/components/schemas/BusinessListItem' - type: object properties: metadata: type: object description: >- بيانات وصفية مخصصة بتنسيق JSON أرفقتها بهذه الشركة. القيمة الافتراضية هي `{}`. updated_at: type: string format: date-time BusinessListItem: type: object description: شركة تم التحقق منها. properties: didit_internal_id: type: string format: uuid description: معرّف UUID الداخلي الثابت من Didit لهذه الشركة. vendor_data: type: string nullable: true description: >- معرّفك الفريد لهذه الشركة (يتم تمريره عند إنشاء الجلسات). يمكن أن يكون هذا null في حال عدم تقديم معرّف بائع. display_name: type: string nullable: true description: اسم عرض مخصص تم تعيينه بواسطتك legal_name: type: string nullable: true description: الاسم القانوني الرسمي من السجل أو الإدخال اليدوي registration_number: type: string nullable: true description: رقم تسجيل أو تأسيس الشركة country_code: type: string nullable: true description: دولة التأسيس (ISO 3166-1 alpha-2، مثل `GB` أو `US`). effective_name: type: string nullable: true description: 'أفضل اسم متاح: display_name إذا كان محدداً، وإلا فـ legal_name' status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- حالة دورة حياة سجل الشركة (ليست حالة جلسة). القيمة الافتراضية هي `ACTIVE`، و`FLAGGED` تميز السجل للمراجعة اليدوية، و`BLOCKED` تمنع إنشاء جلسات جديدة لقيمة `vendor_data` هذه. session_count: type: integer description: العدد الإجمالي لجلسات التحقق لهذه الشركة approved_count: type: integer description: عدد الجلسات المقبولة declined_count: type: integer description: عدد الجلسات المرفوضة in_review_count: type: integer description: عدد الجلسات قيد المراجعة features: type: object description: >- الحالة المجمعة لكل ميزة عبر جميع جلسات KYB الخاصة بهذه الشركة. المفتاح الوحيد حالياً هو `KYB` (حالة فحص الشركة في السجل). القيم المحتملة: `Approved`، `Declined`، `In Review`، `Not Finished`، `Resub Requested`. features_list: type: array items: type: object properties: feature: type: string status: type: string description: >- البيانات نفسها مثل `features`، كمصفوفة مرتبة من كائنات `{feature, status}`. last_session_at: type: string format: date-time nullable: true description: الطابع الزمني لأحدث جلسة first_session_at: type: string format: date-time nullable: true description: الطابع الزمني للجلسة الأولى last_activity_at: type: string format: date-time nullable: true description: الطابع الزمني لأحدث نشاط (تغيير الحالة، تحديث الجلسة، إلخ) tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: العلامات المعيّنة لهذه الشركة created_at: type: string format: date-time 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، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.