> ## 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 de llistat d'empreses: entitats KYB de proveïdors > Consulta totes les entitats de Didit Business (KYB) de la teva aplicació, amb filtres per estat, país, cerca i data. Cicle de vida KYB programàtic. Prompt per llistar empreses Copia el prompt al porta-retalls \

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

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": ,
"next": ,
"previous": ,
"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.`

\
Enganxa a ## Visió generalRetorna una llista paginada d'[entitats empresarials](https://docs.didit.me/ca/entities/businesses/overview.md) de l'aplicació autenticada.## Quan utilitzar-lo- **Sincronitza** la taula d'empreses amb un BI extern o un magatzem de dades. - **Cues d'analistes**: filtra per `status=FLAGGED` per alimentar una safata de revisió. - **Cerca** per `display_name`, `legal_name`, `registration_number` o `vendor_data`.## Filtres i paginació| Paràmetre de consulta | Descripció | | - | - | | `status` | `ACTIVE`, `FLAGGED` o `BLOCKED`. | | `search` | Coincidència de subcadena en el nom visible, el nom legal, el registre i vendor\_data. | | `country_code` | Codi de país ISO 3166-1 alpha-3 de constitució. | | `created_after`, `created_before` | Finestra de dates de creació. | | `last_activity_after`, `last_activity_before` | Finestra d'activitat. | | `page_size` | 1–200. Per defecte, 50. | | `cursor` | Cursor de paginació. |## Notes- `vendor_data` pot ser `null` si la sessió o la transacció d'origen no n'han proporcionat cap. - Paginació basada en cursor: conserva el cursor `next` entre crides. - Consulta el [model de dades d'empresa](https://docs.didit.me/ca/entities/businesses/data-model.md) per a tots els camps.## PermisosEl rol ha de concedir `list:businesses`.## Relacionat- [Visió general d'empreses](https://docs.didit.me/ca/entities/businesses/overview.md) - [Obtenir empresa](https://docs.didit.me/ca/management-api/businesses/get.md) - [Operacions d'empresa](https://docs.didit.me/ca/entities/businesses/operations.md) ## OpenAPI ````yaml ca/openapi-25.json GET /v3/businesses/ 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/: get: tags: - Businesses summary: Llista les empreses description: >- Llista les [empreses](/entities/businesses) que Didit reuneix a partir de sessions de KYB que comparteixen el mateix `vendor_data` (cadena de text lliure, NO pas un UUID), a més de les empreses creades mitjançant l'API. Paginat, ordenat per `last_session_at` descendent. Aquest endpoint no admet paràmetres de filtre ni de cerca; obtén les pàgines i filtra al costat del client. operationId: list_businesses parameters: - name: limit in: query schema: type: integer default: 50 minimum: 1 maximum: 1000000 description: >- Mida de la pàgina. Per defecte és 50 si s'omet. No hi ha cap màxim imposat, però mantén les pàgines petites per reduir la latència. - name: offset in: query schema: type: integer maximum: 1000000 minimum: 0 default: 0 description: >- Desplaçament basat en zero del primer registre a retornar. És preferible seguir l'URL `next` de la pàgina anterior abans que calcular-ho manualment. responses: '200': description: >- Llista paginada d'empreses amb estat, recomptes de sessions i desglossament de funcionalitats. content: application/json: schema: type: object properties: count: type: integer description: >- Nombre de files coincidents: exacte fins a 100, limitat a 100 a partir d'aquí per motius de rendiment. No el facis servir per detectar la darrera pàgina; confia en canvi que `next` sigui `null`. next: type: string nullable: true description: >- URL absoluta de la pàgina següent, o `null` a l'última pàgina. previous: type: string nullable: true description: >- URL absoluta de la pàgina anterior, o `null` a 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: >- Clau d'API absent, no vàlida o revocada, o bé la clau no pot llistar empreses per a 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. '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/?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: |- 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 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.