> ## 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: Entidade KYB do fornecedor > Obtenha uma empresa Didit (KYB) pelo vendor_data, com identidade do registo, estado, contadores KYB agregados e mapa de funcionalidades. Pago por chamada. Prompt para obter empresa Copiar o prompt para a área de transferência \

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

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

\
Colar em ## Visão geralDevolve uma única [entidade Empresa](https://docs.didit.me/pt/entities/businesses/overview.md) identificada pelo `vendor_data`.## Quando usar- **Consulta** do estado de verificação atual de uma empresa: o mapa `features` mostra, de relance, o estado mais recente de cada funcionalidade KYB. - **Vistas de detalhe** no seu próprio painel de administração. - **Pontuação de risco** com base nos contadores agregados e nos estados das funcionalidades.## Notas- O `vendor_data` no URL é sensível a maiúsculas e minúsculas. - Devolve `404` se não existir nenhuma empresa com esse `vendor_data`. - Os contadores agregados (`session_count`, `approved_count`, `declined_count`, `in_review_count`) são atualizados em tempo real à medida que as sessões de Verificação de empresas (KYB) são concluídas. - Os campos obtidos do registo (`legal_name`, `registration_number`, `country_code`) refletem a sessão de Verificação de empresas (KYB) aprovada mais recente.## PermissõesA função tem de conceder `read:businesses`.## Relacionados- [Visão geral das empresas](https://docs.didit.me/pt/entities/businesses/overview.md) - [Modelo de dados](https://docs.didit.me/pt/entities/businesses/data-model.md) - [Listar empresas](https://docs.didit.me/pt/management-api/businesses/list.md) ## OpenAPI ````yaml pt/openapi-25.json GET /v3/businesses/{vendor_data}/ 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/{vendor_data}/: get: tags: - Businesses summary: Obter empresa description: >- Obter uma [empresa](/entities/businesses) por `vendor_data` (correspondência exata). Adiciona `metadata` e `updated_at` à visualização em lista. Empresas eliminadas devolvem 404. operationId: get_business parameters: - name: vendor_data in: path required: true schema: type: string description: >- O seu identificador exclusivo para a empresa — uma string de formato livre (NÃO um UUID), correspondida exatamente como enviada. example: company-123 responses: '200': description: >- Detalhe completo da empresa incluindo metadados e dados agregados da sessão. 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: >- Chave de API em falta, inválida ou revogada, ou a chave não pode ler as empresas desta 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. '404': description: >- Não existe nenhuma empresa (não eliminada) com o `vendor_data` fornecido para esta aplicação. content: application/json: examples: Not found: value: detail: Not found. '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/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: |- 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: >- Detalhe completo da empresa. Estende BusinessListItem com metadados e updated_at. allOf: - $ref: '#/components/schemas/BusinessListItem' - type: object properties: metadata: type: object description: >- JSON de metadados personalizados que associou a esta empresa. O valor predefinido é `{}`. updated_at: type: string format: date-time 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.