> ## 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 para listar empresas: entidades KYB de proveedores

> Obtén todas las entidades de empresa (KYB) de Didit de tu aplicación con filtros por estado, país, búsqueda y fecha. Ciclo de vida KYB programático.



Prompt para listar empresas
        Copiar el prompt al portapapeles



      
      

\<pre>

\`Goal: Page through Didit Business (KYB) entities for an application and consume them in your backend.

Endpoint: GET https://verification.didit.me/v3/businesses/
Auth header: x-api-key: <DIDIT_API_KEY>

Query params (all optional):
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices, NOT the session enum).
\- search: free-text over vendor_data, display_name, legal_name, registration_number.
\- country: country of incorporation, ISO 3166-1 alpha-2 (e.g. "GB", "US").
\- limit: integer, 1–200, default 50.
\- offset: integer, 0+, default 0. Prefer following the "next" URL from the previous page.

curl:
curl -X GET 'https://verification.didit.me/v3/businesses/?limit=50&status=ACTIVE' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (envelope):
\{
"count": <int — exact up to 100, capped above; pagination still works via "next">,
"next": <URL or null>,
"previous": <URL or null>,
"results": [ BusinessListItem, ... ]
}

BusinessListItem key fields: didit_internal_id (UUID), vendor_data (string, may be null), display_name, legal_name, registration_number, country_code, effective_name, status, session_count, approved_count, declined_count, in_review_count, features (map: KYB_REGISTRY, KYB_AML, KYB_DOCUMENTS, ... -> latest status), features_list, last_session_at, first_session_at, last_activity_at, tags, created_at. See /reference/data-models for the full shape.

Notes:
\- Ordered by last_session_at desc.
\- Deleted businesses are not returned.
\- vendor_data is a free-form client-supplied string, NOT a UUID; may be null when the originating session didn't provide one.

Pagination loop:
url = 'https://verification.didit.me/v3/businesses/?limit=200&status=FLAGGED'
while url:
r = requests.get(url, headers={'x-api-key': API_KEY})
r.raise_for_status()
page = r.json()
for biz in page['results']:
    ...
url = page['next']

Failure modes (envelope {"detail": "..."}):
\- 401 — missing/invalid x-api-key.
\- 403 — key lacks list:businesses.
\- 429 — rate-limited.

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

\</pre>



      
      

Pegar en

## Descripción generalDevuelve una lista paginada de [entidades comerciales](https://docs.didit.me/es/entities/businesses/overview.md) de la aplicación autenticada.## Cuándo usarlo- **Sincroniza** tu tabla de empresas con una herramienta de BI o un data warehouse externo.
- **Colas de analistas**: filtra por `status=FLAGGED` para alimentar una bandeja de revisión.
- **Buscar** por `display_name`, `legal_name`, `registration_number` o `vendor_data`.## Filtros y paginación| Parámetro de consulta | Descripción |
| - | - |
| `status` | `ACTIVE`, `FLAGGED` o `BLOCKED`. |
| `search` | Coincidencia de subcadena en el nombre visible, la razón social, el registro y vendor\_data. |
| `country_code` | País de constitución en formato ISO 3166-1 alfa-3. |
| `created_after`, `created_before` | Intervalo de fechas de creación. |
| `last_activity_after`, `last_activity_before` | Intervalo de actividad. |
| `page_size` | De 1 a 200. Valor predeterminado: 50. |
| `cursor` | Cursor de paginación. |## Notas- `vendor_data` puede ser `null` si la sesión o la transacción de origen no lo proporcionaron.
- La paginación se basa en cursores: guarda el cursor `next` entre llamadas.
- Consulta el [modelo de datos de empresa](https://docs.didit.me/es/entities/businesses/data-model.md) para ver todos los campos.## PermisosEl rol debe otorgar `list:businesses`.## Relacionado- [Descripción general de empresas](https://docs.didit.me/es/entities/businesses/overview.md)
- [Obtener empresa](https://docs.didit.me/es/management-api/businesses/get.md)
- [Operaciones de empresas](https://docs.didit.me/es/entities/businesses/operations.md)


## OpenAPI

````yaml es/openapi-25.json GET /v3/businesses/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/:
    get:
      tags:
        - Businesses
      summary: Listar empresas
      description: >-
        Lista las [empresas](/entities/businesses) que Didit agrupa a partir de
        las sesiones KYB que comparten el mismo `vendor_data` (cadena de texto
        libre, NO un UUID), además de las empresas creadas mediante la API.
        Paginado y ordenado por `last_session_at` en orden descendente. Este
        endpoint no admite parámetros de filtrado ni de búsqueda: obtén las
        páginas y filtra en el cliente.
      operationId: list_businesses
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
          description: >-
            Tamaño de página. Si se omite, el valor predeterminado es 50. No hay
            un máximo obligatorio, pero mantén las páginas pequeñas para reducir
            la latencia.
        - name: offset
          in: query
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
          description: >-
            Desplazamiento, empezando en cero, del primer registro que se
            devuelve. Es preferible seguir la URL `next` de la página anterior
            en lugar de calcularlo a mano.
      responses:
        '200':
          description: >-
            Lista paginada de empresas con su estado, número de sesiones y
            desglose por función.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Número de filas coincidentes: exacto hasta 100, limitado a
                      100 a partir de ahí por rendimiento. No lo uses para
                      detectar la última página; comprueba en su lugar que
                      `next` sea `null`.
                  next:
                    type: string
                    nullable: true
                    description: >-
                      URL absoluta de la página siguiente, o `null` en la última
                      página.
                  previous:
                    type: string
                    nullable: true
                    description: >-
                      URL absoluta de la página anterior, o `null` en la primera
                      página.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/BusinessListItem'
              examples:
                Example:
                  value:
                    count: 1
                    next: null
                    previous: null
                    results:
                      - 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'
        '403':
          description: >-
            Falta la clave de API, no es válida o fue revocada, o la clave no
            puede listar las empresas de esta aplicación. Si falta la clave, se
            devuelve `403`; si es incorrecta, fue revocada o expiró, se devuelve
            `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '429':
          description: >-
            Límite de solicitudes superado; espera y reintenta cuando haya
            pasado el intervalo indicado en `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/?limit=50'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.businesses.list():
                print(item)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            for await (const item of didit.businesses.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Businesses.ListAutoPaging(ctx, didit.BusinessesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            for (var item : client.businesses().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

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

            foreach ($didit->businesses->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            didit.businesses.list.auto_paging_each do |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            await foreach (var item in await client.Businesses.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    BusinessListItem:
      type: object
      description: Una empresa verificada.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID interno estable de Didit para esta empresa.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Tu identificador único de esta empresa (el que se envía al crear
            sesiones). Puede ser null si no se proporcionó ningún identificador
            propio.
        display_name:
          type: string
          nullable: true
          description: Nombre visible personalizado que has definido
        legal_name:
          type: string
          nullable: true
          description: Razón social oficial obtenida del registro o introducida manualmente
        registration_number:
          type: string
          nullable: true
          description: Número de registro o de constitución de la empresa
        country_code:
          type: string
          nullable: true
          description: País de constitución (ISO 3166-1 alfa-2, p. ej., `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Mejor nombre disponible: display_name si está definido; si no,
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Estado del ciclo de vida del registro de la empresa (NO es un estado
            de sesión). `ACTIVE` es el valor predeterminado, `FLAGGED` lo marca
            para atención manual y `BLOCKED` impide nuevas sesiones para este
            `vendor_data`.
        session_count:
          type: integer
          description: Número total de sesiones de verificación de esta empresa
        approved_count:
          type: integer
          description: Número de sesiones aprobadas
        declined_count:
          type: integer
          description: Número de sesiones rechazadas
        in_review_count:
          type: integer
          description: Número de sesiones en revisión
        features:
          type: object
          description: >-
            Estado agregado por función de todas las sesiones KYB de esta
            empresa. Actualmente la única clave es `KYB` (el estado de la
            comprobación de la empresa en el registro). Valores posibles:
            `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub
            Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Los mismos datos que `features`, como un array ordenado de objetos
            `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de tiempo de la sesión más reciente
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de tiempo de la primera sesión
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Marca de tiempo de la actividad más reciente (cambio de estado,
            actualización de la sesión, etc.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Etiquetas asignadas a esta empresa
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clave de API de tu aplicación, que encontrarás en Developers -> API
        keys en la Business Console. La clave principal tiene acceso completo.
        Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
        escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
        a una lista de direcciones IP y a una fecha de caducidad. 401 significa
        que la clave es incorrecta, se revocó o expiró; 403 significa que no se
        envió ninguna clave, que la clave no tiene acceso a este recurso o
        acción, o que la solicitud provino de una dirección fuera de su lista de
        IP; 404 en una ruta de sesión significa que la sesión está fuera de los
        flujos o estados de la clave. Una clave sin acceso a contenido
        multimedia recibe las URL de imágenes, videos y PDF como null, y una
        clave sin permiso de escritura en sesiones recibe los enlaces y tokens
        de sesión como null. Consulta https://docs.didit.me/console/api-keys.

````

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