> ## 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 criar empresa: entidade KYB de fornecedor > Pré-cadastre entidades de empresa (KYB) na Didit antes das sessões KYB. Importe em massa de bases externas ou registre para monitorar transações. Prompt para criar empresa Copiar o prompt para a área de transferência \

\`Goal: Pre-create a Didit Business (KYB) entity by vendor_data before any KYB session runs.

Endpoint: POST https://verification.didit.me/v3/businesses/create/
Auth header: x-api-key: 
Content-Type: application/json

Request body fields:
\- vendor_data (string, REQUIRED) — your unique identifier. Free-form string, NOT a UUID. Must be unique among non-deleted businesses for the app. Normalised lowercase + whitespace trim ("COMPANY-1" and "company-1" collide).
\- display_name (string, nullable) — friendly display name shown in Console (takes precedence over legal_name).
\- legal_name (string, nullable)
\- registration_number (string, nullable)
\- country_code (string, nullable) — country of incorporation, ISO 3166-1 alpha-2 (e.g. "GB", "US").
\- region (string, nullable) — ISO 3166-2 subdivision code.
\- status (enum) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices). Defaults to "ACTIVE".
\- metadata (object, nullable) — arbitrary JSON.

curl:
curl -X POST 'https://verification.didit.me/v3/businesses/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "company-456", "legal_name": "New Corp Ltd", "country_code": "US"}'

Response 201: full BusinessDetailItem (same shape as GET /v3/businesses/{vendor_data}/). Includes didit_internal_id (UUID), session_count=0, metadata, comments=[], created_at, updated_at. See /reference/data-models.

Failure modes (envelope {"detail": "..."} for auth):
\- 400 — validation errors keyed by field. Common cases:
\{ "vendor_data": ["A business with this vendor_data already exists."] }  // NOT idempotent — use PATCH /v3/businesses/{vendor_data}/ to update.
\{ "vendor_data": ["This field is required."] }
\{ "metadata": ["Metadata must be a JSON object."] }
\- 401 — missing/invalid x-api-key.
\- 403 — lacks create:businesses.
\- 429 — rate-limited.

Upsert pattern (NOT idempotent on vendor_data):
GET /v3/businesses/{vendor_data}/  → on 404, POST /v3/businesses/create/; on 200, PATCH /v3/businesses/{vendor_data}/.

Notes:
\- Registry-derived fields (legal_name, registration_number, country_code) can be seeded here but will be OVERWRITTEN by the first approved Business Verification (KYB) session's registry data.
\- last_activity_at is set at the moment of creation.

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

\
Colar em ## Visão geralCria explicitamente uma [entidade empresarial](https://docs.didit.me/pt-br/entities/businesses/overview.md) antes que qualquer sessão de Verificação de empresas (KYB) seja executada.## Quando usar- **Preencher previamente metadados** (parceiro, nível, identificadores internos) antes da primeira sessão de Verificação de empresas (KYB). - **Migrar** de outro fornecedor de KYB com uma base de empresas já existente. - **Cadastro apenas para transações**: envie transações de uma empresa que você verificou por um processo offline.## Observações- `vendor_data` é obrigatório e único por aplicação. Valores duplicados geram um erro de conflito. Use [`PATCH /v3/businesses/{vendor_data}/`](https://docs.didit.me/pt-br/management-api/businesses/update) para atualizar. - Os campos derivados do registro de empresas (`legal_name`, `registration_number`, `country_code`) podem ser pré-carregados, mas serão **sobrescritos** pelos dados do registro de empresas da primeira sessão de Verificação de Empresa (KYB) aprovada. - Se `country_code` corresponder à lista de [países perigosos](https://docs.didit.me/pt-br/entities/businesses/blocklist.md#países-perigosos) da sua aplicação, a empresa será criada com o status `BLOCKED`. - Emite `business.data.updated`.## PermissõesA função deve conceder `create:businesses`.## Relacionados- [Modelo de dados de empresas](https://docs.didit.me/pt-br/entities/businesses/data-model.md) - [Vinculação de dados de fornecedores](https://docs.didit.me/pt-br/entities/vendor-data-linking.md) - [Operações de empresas](https://docs.didit.me/pt-br/entities/businesses/operations.md) ## OpenAPI ````yaml pt-br/openapi-25.json POST /v3/businesses/create/ 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/create/: post: tags: - Businesses summary: Criar empresa description: >- Cria previamente uma [empresa](/entities/businesses) *sem* uma sessão KYB. Todos os campos são opcionais, mas você deve sempre enviar `vendor_data`: sem ele, o registro não pode ser vinculado a sessões nem a transações. Quando informado, `vendor_data` deve ser único entre as empresas não excluídas (correspondência exata; conflitos retornam 400). Não é idempotente. operationId: create_business requestBody: required: true content: application/json: schema: type: object properties: vendor_data: type: string nullable: true description: >- Seu identificador exclusivo desta empresa (string livre, NÃO um UUID). Opcional, mas fortemente recomendado. Quando informado, deve ser único entre as empresas não excluídas da aplicação; comparado exatamente como enviado. display_name: type: string nullable: true maxLength: 255 description: >- Nome de exibição amigável mostrado no console (tem prioridade sobre `legal_name` na exibição da interface). legal_name: type: string nullable: true maxLength: 255 description: Razão social oficial da empresa. registration_number: type: string nullable: true maxLength: 100 description: Número de registro ou de constituição da empresa. country_code: type: string nullable: true maxLength: 10 description: >- País de constituição (ISO 3166-1 alpha-2, por exemplo, `GB`, `US`). status: type: string enum: - ACTIVE - FLAGGED - BLOCKED default: ACTIVE description: Status inicial do ciclo de vida. O padrão é `ACTIVE`. metadata: type: object nullable: true description: >- Objeto JSON arbitrário que você anexa à empresa. O padrão é `{}`. examples: Basic: summary: Mínimo recomendado value: vendor_data: company-456 legal_name: New Corp Ltd country_code: US Full: summary: Todos os campos value: vendor_data: company-789 display_name: New Corp legal_name: New Corp International Ltd registration_number: '98765432' country_code: DE status: ACTIVE metadata: industry: fintech tier: enterprise responses: '201': description: >- Empresa criada. Retorna o registro completo da empresa (mesmo formato de Get Business). content: application/json: schema: $ref: '#/components/schemas/BusinessDetailItem' examples: Created: value: didit_internal_id: a1b2c3d4-e5f6-4890-abcd-ef1234567890 vendor_data: company-456 display_name: null legal_name: New Corp Ltd registration_number: null country_code: US effective_name: New Corp Ltd status: ACTIVE session_count: 0 approved_count: 0 declined_count: 0 in_review_count: 0 features: {} features_list: [] last_session_at: null last_activity_at: '2026-03-15T10:30:00Z' first_session_at: null tags: [] created_at: '2026-03-15T10:30:00Z' metadata: {} updated_at: '2026-03-15T10:30:00Z' '400': description: >- Corpo inválido: normalmente um `vendor_data` duplicado, um `status` desconhecido ou `metadata` malformado. content: application/json: examples: Duplicate: value: vendor_data: - A business with this vendor_data already exists. Bad status: value: status: - >- Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED Bad metadata: value: metadata: - Metadata must be a JSON object. '403': description: >- Chave de API ausente, inválida ou revogada, ou a chave não pode criar empresas para esta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '429': description: >- Limite de requisições excedido; aguarde 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 POST 'https://verification.didit.me/v3/businesses/create/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"vendor_data": "company-456", "legal_name": "New Corp Ltd", "country_code": "US"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.businesses.create( vendor_data="company-456", legal_name="New Corp Ltd", country_code="US", ) 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.create({ vendor_data: "company-456", legal_name: "New Corp Ltd", country_code: "US", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Create(ctx, didit.BusinessesCreateParams{\n\tVendorData: didit.String(\"company-456\"),\n\tLegalName: didit.String(\"New Corp Ltd\"),\n\tCountryCode: didit.String(\"US\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.BusinessesCreateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.businesses().create(BusinessesCreateParams.builder() .vendorData("company-456") .legalName("New Corp Ltd") .countryCode("US") .build()); System.out.println(result); - lang: php label: PHP source: |- businesses->create([ 'vendor_data' => 'company-456', 'legal_name' => 'New Corp Ltd', 'country_code' => 'US', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.businesses.create( vendor_data: "company-456", legal_name: "New Corp Ltd", country_code: "US" ) 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.CreateAsync(new BusinessesCreateParams { VendorData = "company-456", LegalName = "New Corp Ltd", CountryCode = "US", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: BusinessDetailItem: type: object description: >- Detalhes completos da empresa. Estende BusinessListItem com metadata e updated_at. allOf: - $ref: '#/components/schemas/BusinessListItem' - type: object properties: metadata: type: object description: >- JSON de metadados personalizados que você anexou a esta empresa. O padrão é `{}`. 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: >- Seu identificador exclusivo desta empresa (passado ao criar sessões). Pode ser nulo quando nenhum identificador do fornecedor foi informado. display_name: type: string nullable: true description: Nome de exibição personalizado definido por você legal_name: type: string nullable: true description: >- Razão social oficial obtida do registro de empresas ou inserida manualmente registration_number: type: string nullable: true description: Número de registro ou de constituição da empresa country_code: type: string nullable: true description: País de constituição (ISO 3166-1 alpha-2, por exemplo, `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: >- Status do ciclo de vida do registro da empresa (NÃO é um status de sessão). `ACTIVE` é o padrão, `FLAGGED` o marca para atenção manual e `BLOCKED` impede novas sessões para este `vendor_data`. session_count: type: integer description: Número total de sessões de verificação desta 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 revisão features: type: object description: >- Status agregado por recurso em todas as sessões de KYB desta empresa. Atualmente, a única chave é `KYB` (o status da verificação da empresa no registro). 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 de `features`, como um array ordenado de objetos `{feature, status}`. last_session_at: type: string format: date-time nullable: true description: Data e hora da sessão mais recente first_session_at: type: string format: date-time nullable: true description: Data e hora da primeira sessão last_activity_at: type: string format: date-time nullable: true description: >- Data e hora da atividade mais recente (mudança de status, 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: Tags atribuídas a esta empresa created_at: type: string format: date-time securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.