> ## 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 fornecedores > Obtenha todas as entidades de empresas (KYB) da Didit na sua aplicação, filtradas por estado, país, pesquisa e data. Ciclo KYB via API. Prompt para listar empresas Copiar o prompt para a área de transferência \

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

\
Colar em ## Visão geralDevolve uma lista paginada das [entidades Business](https://docs.didit.me/pt/entities/businesses/overview.md) da aplicação autenticada.## Quando usar- **Sincronize** a sua tabela de empresas com uma ferramenta de BI externa ou com um data warehouse. - **Filas dos analistas**: filtre por `status=FLAGGED` para alimentar uma caixa de entrada de revisão. - **Pesquise** por `display_name`, `legal_name`, `registration_number` ou `vendor_data`.## Filtros e paginação| Parâmetro de consulta | Descrição | | - | - | | `status` | `ACTIVE`, `FLAGGED` ou `BLOCKED`. | | `search` | Correspondência parcial no nome de exibição, no nome legal, no número de registo e em vendor\_data. | | `country_code` | Código do país de constituição, no formato ISO 3166-1 alfa-3. | | `created_after`, `created_before` | Intervalo de datas de criação. | | `last_activity_after`, `last_activity_before` | Intervalo de atividade. | | `page_size` | 1–200. Predefinido: 50. | | `cursor` | Cursor de paginação. |## Notas- `vendor_data` pode ser `null` se a sessão ou a transação de origem não o tiver fornecido. - Paginação por cursor: guarde o cursor `next` entre chamadas. - Consulte o [modelo de dados Business](https://docs.didit.me/pt/entities/businesses/data-model.md) para ver todos os campos.## PermissõesA função tem de conceder `list:businesses`.## Relacionados- [Visão geral das empresas](https://docs.didit.me/pt/entities/businesses/overview.md) - [Obter empresa](https://docs.didit.me/pt/management-api/businesses/get.md) - [Operações sobre empresas](https://docs.didit.me/pt/entities/businesses/operations.md) ## OpenAPI ````yaml pt/openapi-25.json GET /v3/businesses/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/businesses/: get: tags: - Businesses summary: Listar empresas description: >- Listar [empresas](/entities/businesses) que a Didit reúne a partir de sessões de KYB que partilham o mesmo `vendor_data` (cadeia de carateres livre, NÃO um UUID), mais empresas criadas através da API. Paginado, ordenado por `last_session_at` desc. Este endpoint não suporta parâmetros de filtro ou pesquisa — obtenha as páginas e filtre do lado do cliente. operationId: list_businesses parameters: - name: limit in: query schema: type: integer default: 50 minimum: 1 maximum: 1000000 description: >- Tamanho da página. A predefinição é 50 quando omitido. Não existe um limite máximo imposto, mas mantenha as páginas pequenas para reduzir a latência. - name: offset in: query schema: type: integer maximum: 1000000 minimum: 0 default: 0 description: >- Offset de base zero do primeiro registo a devolver. Prefira seguir o URL `next` da página anterior em vez de calcular este valor manualmente. responses: '200': description: >- Lista paginada de empresas com estado, contagem de sessões e detalhe de funcionalidades. content: application/json: schema: type: object properties: count: type: integer description: >- Número de linhas correspondentes — exato até 100, limitado a 100 acima disso por motivos de desempenho. Não o utilize para detetar a última página; em vez disso, confie no facto de `next` ser `null`. next: type: string nullable: true description: >- URL absoluto da página seguinte, ou `null` na última página. previous: type: string nullable: true description: >- URL absoluto da página anterior, ou `null` na primeira 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: >- Chave de API em falta, inválida ou revogada, ou a chave não pode listar empresas para esta aplicação. Uma chave em falta devolve `403`; uma chave incorreta, revogada ou expirada devolve `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '429': description: >- Limite de pedidos excedido; reduza a frequência e tente novamente após o intervalo indicado em `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: Uma empresa verificada. properties: didit_internal_id: type: string format: uuid description: UUID interno estável da Didit para esta empresa. vendor_data: type: string nullable: true description: >- O seu identificador exclusivo para esta empresa (transmitido ao criar sessões). Pode ser nulo quando não tiver sido fornecido nenhum identificador de fornecedor. display_name: type: string nullable: true description: Nome de apresentação personalizado definido por si legal_name: type: string nullable: true description: >- Denominação legal oficial proveniente do registo ou introduzida manualmente registration_number: type: string nullable: true description: Número de registo ou de constituição da empresa country_code: type: string nullable: true description: País de constituição (ISO 3166-1 alpha-2, por ex., `GB`, `US`). effective_name: type: string nullable: true description: >- Melhor nome disponível: display_name se definido, caso contrário legal_name status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- Estado do ciclo de vida do registo da empresa (NÃO é um estado da sessão). `ACTIVE` é o padrão, `FLAGGED` marca-o para atenção manual, `BLOCKED` impede novas sessões para este `vendor_data`. session_count: type: integer description: Número total de sessões de verificação para esta empresa approved_count: type: integer description: Número de sessões aprovadas declined_count: type: integer description: Número de sessões recusadas in_review_count: type: integer description: Número de sessões em análise features: type: object description: >- Estado agregado por funcionalidade em todas as sessões de KYB desta empresa. Atualmente, a única chave é `KYB` (o estado da verificação da empresa no registo). Valores possíveis: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`. features_list: type: array items: type: object properties: feature: type: string status: type: string description: >- Os mesmos dados que `features`, como um array ordenado de objetos `{feature, status}`. last_session_at: type: string format: date-time nullable: true description: Carimbo de data/hora da sessão mais recente first_session_at: type: string format: date-time nullable: true description: Carimbo de data/hora da primeira sessão last_activity_at: type: string format: date-time nullable: true description: >- Carimbo de data/hora da atividade mais recente (mudança de estado, atualização da sessão, etc.) tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: Etiquetas atribuídas a esta empresa created_at: type: string format: date-time securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.