> ## 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 Get Business: entitat KYB del proveïdor

> Obtén un Business (KYB) de Didit amb vendor_data: identitat del registre, estat, comptadors KYB agregats i mapa de funcionalitats. De pagament per crida.



Prompt per obtenir una empresa
        Copia el prompt al porta-retalls



      
      

\<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>



      
      

Enganxa a

## Visió generalRetorna una única entitat [empresa](https://docs.didit.me/ca/entities/businesses/overview.md) identificada per `vendor_data`.## Quan utilitzar-lo- **Consulta** de l'estat de verificació actual d'una empresa: el mapa `features` et mostra d'un cop d'ull l'estat més recent de cada funcionalitat KYB.
- **Vistes de detall** a la teva pròpia interfície d'administració.
- **Puntuació de risc** a partir dels comptadors agregats i dels estats de les funcionalitats.## Notes- `vendor_data` a la URL distingeix entre majúscules i minúscules.
- Retorna `404` si no existeix cap empresa amb aquest `vendor_data`.
- Els comptadors agregats (`session_count`, `approved_count`, `declined_count`, `in_review_count`) s'actualitzen en temps real a mesura que es completen les sessions de Verificació d'empreses (KYB).
- Els camps derivats del registre (`legal_name`, `registration_number`, `country_code`) reflecteixen la sessió de Verificació d'empreses (KYB) aprovada més recent.## PermisosEl rol ha de concedir `read:businesses`.## Relacionat- [Visió general de les empreses](https://docs.didit.me/ca/entities/businesses/overview.md)
- [Model de dades](https://docs.didit.me/ca/entities/businesses/data-model.md)
- [Llista d'empreses](https://docs.didit.me/ca/management-api/businesses/list.md)


## OpenAPI

````yaml ca/openapi-25.json GET /v3/businesses/{vendor_data}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/:
    get:
      tags:
        - Businesses
      summary: Obtenir l'empresa
      description: >-
        Obtén una [empresa](/entities/businesses) per `vendor_data`
        (coincidència exacta). Afegeix `metadata` i `updated_at` a la vista de
        llista. Les empreses eliminades retornen 404.
      operationId: get_business
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            El teu identificador únic per a l'empresa — una cadena de text
            lliure (NO un UUID), que coincideix exactament amb el valor enviat.
          example: company-123
      responses:
        '200':
          description: >-
            Detall complet de l'empresa, incloses les metadades i les dades
            agregades de la sessió.
          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: >-
            Clau d'API absent, no vàlida o revocada, o bé la clau no pot llegir
            les empreses d'aquesta aplicació. Una clau absent retorna `403`; una
            clau incorrecta, revocada o caducada retorna `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            No existeix cap empresa (no eliminada) amb el `vendor_data`
            proporcionat per a aquesta aplicació.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            S'ha superat el límit de freqüència; redueix el ritme de les
            sol·licituds i reintenta-ho després de l'interval indicat a
            `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: >-
        Detall complet de l'empresa. Amplia BusinessListItem amb metadades i
        updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON de metadades personalitzades que has adjuntat a aquesta
                empresa. Per defecte és `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: Una empresa verificada.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID intern estable de Didit per a aquesta empresa.
        vendor_data:
          type: string
          nullable: true
          description: >-
            El teu identificador únic per a aquesta empresa (passat en crear
            sessions). Pot ser nul quan no s'ha proporcionat cap identificador
            de proveïdor.
        display_name:
          type: string
          nullable: true
          description: Nom visible personalitzat definit per tu
        legal_name:
          type: string
          nullable: true
          description: >-
            Nom legal oficial obtingut del registre mercantil o introduït
            manualment
        registration_number:
          type: string
          nullable: true
          description: Número de registre o de constitució de l'empresa
        country_code:
          type: string
          nullable: true
          description: País de constitució (ISO 3166-1 alpha-2, p. ex. `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Millor nom disponible: display_name si està definit, en cas contrari
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Estat del cicle de vida del registre d'empresa (NO és un estat de la
            sessió). `ACTIVE` és el valor per defecte, `FLAGGED` el marca per a
            atenció manual, `BLOCKED` impedeix noves sessions per a aquest
            `vendor_data`.
        session_count:
          type: integer
          description: Nombre total de sessions de verificació per a aquesta empresa
        approved_count:
          type: integer
          description: Nombre de sessions aprovades
        declined_count:
          type: integer
          description: Nombre de sessions rebutjades
        in_review_count:
          type: integer
          description: Nombre de sessions en revisió
        features:
          type: object
          description: >-
            Estat agregat per funcionalitat a totes les sessions de KYB
            d'aquesta empresa. Actualment l'única clau és `KYB` (l'estat de la
            comprovació de l'empresa al registre). Valors possibles: `Approved`,
            `Declined`, `In Review`, `Not Finished`, `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Les mateixes dades que `features`, com una llista ordenada
            d'objectes `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de temps de la sessió més recent
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de temps de la primera sessió
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Marca de temps de l'activitat més recent (canvi d'estat,
            actualització de la sessió, etc.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Etiquetes assignades a aquesta empresa
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

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