> ## 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 Récupérer une entreprise : entité KYB

> Récupérez une entreprise Didit (KYB) via son vendor_data : identité du registre, statut, compteurs KYB, fonctionnalités. Facturé à l'appel.



Prompt pour récupérer une entreprise
        Copier le prompt dans le presse-papiers



      
      

\<pre>

\`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: <DIDIT_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.`

\</pre>



      
      

Coller dans

## AperçuRenvoie une seule [entité d'entreprise](https://docs.didit.me/fr/entities/businesses/overview.md) identifiée par `vendor_data`.## Quand l'utiliser- **Recherche** de l'état de vérification actuel d'une entreprise : le dictionnaire `features` vous donne d'un coup d'œil le statut le plus récent de chaque fonctionnalité KYB.
- **Vues détaillées** dans votre propre interface d'administration.
- **Notation du risque** à partir des compteurs agrégés et des statuts des fonctionnalités.## Remarques- `vendor_data` dans l'URL est sensible à la casse.
- Renvoie `404` si aucune entreprise avec ce `vendor_data` n'existe.
- Les compteurs agrégés (`session_count`, `approved_count`, `declined_count`, `in_review_count`) se mettent à jour en temps réel au fur et à mesure que les sessions de vérification d'entreprise (KYB) se terminent.
- Les champs issus du registre (`legal_name`, `registration_number`, `country_code`) reflètent la dernière session de vérification d'entreprise (KYB) approuvée.## AutorisationsLe rôle doit disposer de l'autorisation `read:businesses`.## Voir aussi- [Vue d'ensemble des entreprises](https://docs.didit.me/fr/entities/businesses/overview.md)
- [Modèle de données](https://docs.didit.me/fr/entities/businesses/data-model.md)
- [Lister les entreprises](https://docs.didit.me/fr/management-api/businesses/list.md)


## OpenAPI

````yaml fr/openapi-25.json GET /v3/businesses/{vendor_data}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/:
    get:
      tags:
        - Businesses
      summary: Obtenir l'entreprise
      description: >-
        Récupérer une [entreprise](/entities/businesses) par `vendor_data`
        (correspondance exacte). Ajoute `metadata` et `updated_at` à la vue de
        liste. Les entreprises supprimées renvoient une erreur 404.
      operationId: get_business
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            Votre identifiant unique pour l'entreprise — chaîne libre (PAS un
            UUID), mise en correspondance exactement telle qu'envoyée.
          example: company-123
      responses:
        '200':
          description: >-
            Détails complets de l'entreprise, y compris les métadonnées et les
            données agrégées de session.
          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: >-
            Clé API manquante, invalide ou révoquée, ou la clé ne peut pas lire
            les entreprises de cette application. Une clé manquante renvoie
            `403` ; une clé incorrecte, révoquée ou expirée renvoie `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Aucune entreprise (non supprimée) avec le `vendor_data` fourni
            n'existe pour cette application.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Limite de débit dépassée ; réduisez la cadence et réessayez après
            l'intervalle indiqué dans `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: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->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: >-
        Détails complets de l'entreprise. Étend BusinessListItem avec
        métadonnées et updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON de métadonnées personnalisées que vous avez associé à cette
                entreprise. La valeur par défaut est `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: Une entreprise vérifiée.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID interne stable de Didit pour cette entreprise.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Votre identifiant unique pour cette entreprise (transmis lors de la
            création des sessions). Peut être nul si aucun identifiant
            fournisseur n'a été fourni.
        display_name:
          type: string
          nullable: true
          description: Nom d'affichage personnalisé défini par vous
        legal_name:
          type: string
          nullable: true
          description: Raison sociale officielle issue du registre ou saisie manuelle
        registration_number:
          type: string
          nullable: true
          description: Numéro d'immatriculation ou de constitution de l'entreprise
        country_code:
          type: string
          nullable: true
          description: Pays de constitution (ISO 3166-1 alpha-2, par ex. `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Meilleur nom disponible : display_name s'il est défini, sinon
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Statut de cycle de vie de l'enregistrement d'entreprise (PAS un
            statut de session). `ACTIVE` est la valeur par défaut, `FLAGGED` le
            signale pour un examen manuel, `BLOCKED` empêche de nouvelles
            sessions pour ce `vendor_data`.
        session_count:
          type: integer
          description: Nombre total de sessions de vérification pour cette entreprise
        approved_count:
          type: integer
          description: Nombre de sessions approuvées
        declined_count:
          type: integer
          description: Nombre de sessions refusées
        in_review_count:
          type: integer
          description: Nombre de sessions en cours d'examen
        features:
          type: object
          description: "Statut agrégé par fonctionnalité sur l'ensemble des sessions KYB de cette entreprise. Actuellement, la seule clé est `KYB` (le statut de vérification de l'entreprise au registre). Valeurs possibles\_: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`."
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Mêmes données que `features`, sous la forme d'un tableau ordonné
            d'objets `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Horodatage de la session la plus récente
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Horodatage de la première session
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Horodatage de l'activité la plus récente (changement de statut, mise
            à jour de la session, etc.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Tags attribués à cette entreprise
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clé API de votre application, issue de Développeurs -> Clés API dans
        la Business Console. La clé principale dispose d'un accès complet. Une
        clé nommée peut être restreinte : aucun, lecture ou écriture par
        ressource, limitée à certains workflows ou aux sessions approuvées, à
        une liste d'adresses IP et à une date d'expiration. 401 signifie que la
        clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a
        été envoyée, que la clé n'a pas accès à cette ressource ou action, ou
        que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur
        une route de session signifie que la session est hors des workflows ou
        des statuts de la clé. Une clé sans accès aux médias reçoit les URL
        d'images, de vidéos et de PDF à null, et une clé sans accès en écriture
        aux sessions reçoit les liens et tokens de session à null. Voir
        https://docs.didit.me/console/api-keys.

````

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