> ## 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 per crear empreses: entitat KYB de proveïdor

> Pre-crea entitats KYB de Didit abans de les sessions. Alta massiva des de bases de dades externes o registre per a monitoratge de transaccions.



Prompt per crear una empresa
        Copia el prompt al porta-retalls



      
      

\<pre>

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

\</pre>



      
      

Enganxa a

## ResumCrea explícitament una [entitat empresarial](https://docs.didit.me/ca/entities/businesses/overview.md) abans que s'iniciï cap sessió de Verificació d'empreses (KYB).## Quan s'ha d'utilitzar- **Precarregar metadades** (soci, nivell, identificadors interns) abans de la primera sessió de Verificació d'empreses (KYB).
- **Migrar** des d'un altre proveïdor de KYB amb un llistat d'empreses existent.
- **Registre només de transaccions**: envia transaccions per a una empresa que has verificat amb un procés fora de línia.## Notes- `vendor_data` és obligatori i únic per aplicació. Els duplicats retornen un error de conflicte: usa [`PATCH /v3/businesses/{vendor_data}/`](https://docs.didit.me/ca/management-api/businesses/update) per actualitzar-la.
- Els camps derivats del registre (`legal_name`, `registration_number`, `country_code`) es poden precarregar, però les dades del registre de la primera sessió de Verificació d'empreses (KYB) aprovada els **sobreescriuran**.
- Si `country_code` coincideix amb la llista de [països perillosos](https://docs.didit.me/ca/entities/businesses/blocklist.md#països-perillosos) de la teva aplicació, l'empresa es crea amb l'estat `BLOCKED`.
- Emet `business.data.updated`.## PermisosEl rol ha d'atorgar el permís `create:businesses`.## Relacionats- [Model de dades de l'empresa](https://docs.didit.me/ca/entities/businesses/data-model.md)
- [Vinculació de dades del proveïdor](https://docs.didit.me/ca/entities/vendor-data-linking.md)
- [Operacions amb empreses](https://docs.didit.me/ca/entities/businesses/operations.md)


## OpenAPI

````yaml ca/openapi-25.json POST /v3/businesses/create/
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/create/:
    post:
      tags:
        - Businesses
      summary: Crea una empresa
      description: >-
        Precrea una [empresa](/entities/businesses) *sense* una sessió de KYB.
        Tots els camps són opcionals, però hauries d'enviar sempre
        `vendor_data`: sense aquest camp, el registre no es pot vincular a
        sessions o transaccions. Quan es proporciona, `vendor_data` ha de ser
        únic entre les empreses no eliminades (coincidència exacta; els
        conflictes retornen 400). No és idempotent.
      operationId: create_business
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                vendor_data:
                  type: string
                  nullable: true
                  description: >-
                    El teu identificador únic per a aquesta empresa (cadena de
                    text lliure, NO un UUID). Opcional però molt recomanable.
                    Quan es proporciona, ha de ser únic entre les empreses no
                    eliminades per a l'aplicació; coincideix exactament amb el
                    valor enviat.
                display_name:
                  type: string
                  nullable: true
                  maxLength: 255
                  description: >-
                    Nom descriptiu que es mostra a la consola (té prioritat
                    sobre `legal_name` per a la visualització a la interfície
                    d'usuari).
                legal_name:
                  type: string
                  nullable: true
                  maxLength: 255
                  description: Nom legal oficial de l'empresa.
                registration_number:
                  type: string
                  nullable: true
                  maxLength: 100
                  description: Número de registre o de constitució de l'empresa.
                country_code:
                  type: string
                  nullable: true
                  maxLength: 10
                  description: País de constitució (ISO 3166-1 alpha-2, p. ex. `GB`, `US`).
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - FLAGGED
                    - BLOCKED
                  default: ACTIVE
                  description: Estat inicial del cicle de vida. Per defecte és `ACTIVE`.
                metadata:
                  type: object
                  nullable: true
                  description: >-
                    Objecte JSON arbitrari que adjuntes a l'empresa. Per defecte
                    és `{}`.
            examples:
              Basic:
                summary: Mínim recomanat
                value:
                  vendor_data: company-456
                  legal_name: New Corp Ltd
                  country_code: US
              Full:
                summary: Tots els camps
                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 creada. Es retorna el registre complet de l'empresa (la
            mateixa estructura que a Obtenir empresa).
          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: >-
            Cos no vàlid — normalment un `vendor_data` duplicat, un `status`
            desconegut o `metadata` amb format incorrecte.
          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: >-
            Falta la clau d'API, no és vàlida o està revocada, o la clau no pot
            crear empreses per a aquesta aplicació. Si falta la clau, es 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 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: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

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

            $result = $didit->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: >-
        Detall complet de l'empresa. Amplia BusinessListItem amb metadades i
        updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON de metadades personalitzades que has adjuntat a aquesta
                empresa. Per defecte és `{}`.
            updated_at:
              type: string
              format: date-time
    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.