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

# Unternehmensstatus per API: sperren oder markieren

> Didit-Unternehmen (KYB) sperren, markieren oder aktivieren. Der Status wirkt auf künftige KYB-Sitzungen und Transaktionsprüfung.



Prompt zum Aktualisieren des Unternehmensstatus
        Prompt in die Zwischenablage kopieren



      
      

\<pre>

\`Goal: Flip ONLY the lifecycle status of a Didit Business (KYB) entity. Use the full PATCH /v3/businesses/{vendor_data}/ when you also need to touch other fields.

Endpoint: PATCH https://verification.didit.me/v3/businesses/{vendor_data}/update-status/
Auth header: x-api-key: <DIDIT_API_KEY>
Content-Type: application/json

Path param:
\- vendor_data (string, REQUIRED) — free-form string, NOT a UUID. URL-encode.

Request body:
\- status (enum, REQUIRED) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices, NOT the session enum).
\- reason (string, optional, max 1000): why the status changed. Recorded on the status-change entry in the company's Activity in the Business Console, only when the status actually changes. Webhooks do not carry it.

Status semantics:
\- ACTIVE  → normal. New KYB sessions allowed for this vendor_data.
\- FLAGGED → still accepted, highlighted in Console for manual review; filterable with ?status=FLAGGED.
\- BLOCKED → terminal. Adds vendor_data to the system blocklist. Subsequent KYB session creations for the same identifier are rejected. Flipping back to ACTIVE/FLAGGED removes the blocklist entry automatically.

curl:
curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/update-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED", "reason": "Registry shows the company dissolved"}'

Response 200: full updated BusinessDetailItem (same shape as GET /v3/businesses/{vendor_data}/). See /reference/data-models.

Side effects:
\- Toggles the system blocklist entry when entering/leaving BLOCKED.
\- Writes one status-change entry to the company's activity (actor = API key identity), with reason as its comment.
\- Idempotent — re-sending the same status is a no-op (no extra audit row, no extra blocklist toggle).

Failure modes:
\- 400 — validation:
\{ "status": "This field is required." }
\{ "status": "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" }
\{ "reason": ["Ensure this field has no more than 1000 characters."] }
\- 401 — missing/invalid x-api-key.
\- 403: a scoped API key without businesses write. { "detail": "This API key has no write access to companies." }
\- 404 — vendor_data not found (or deleted). { "detail": "Not found." }
\- 429 — rate-limited.

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

\</pre>



      
      

Einfügen in

## ÜberblickVerschiebt eine [Unternehmens-Entität](https://docs.didit.me/de/entities/businesses/overview.md) zwischen `ACTIVE`, `FLAGGED` und `BLOCKED`. Die vollständige Zustandslogik finden Sie unter [Lebenszyklus der Entität](https://docs.didit.me/de/entities/lifecycle.md).## Wann Sie es verwenden- **Sperren** Sie ein sanktioniertes oder nachweislich betrügerisches Unternehmen.
- **Markieren** Sie ein Unternehmen, das auf eine manuelle Prüfung wartet.
- **Heben** Sie die **Blockierung auf**, nachdem die Ursache behoben wurde.
- **Übernehmen Sie externe Signale** aus Ihren eigenen Compliance-Systemen.## Hinweise- Gültige Werte: `ACTIVE`, `FLAGGED`, `BLOCKED`.
- Übergeben Sie optional einen `reason` (bis zu 1000 Zeichen), um festzuhalten, warum sich der Status geändert hat.
  Didit speichert ihn im Eintrag zur Statusänderung in der **Aktivität** des Unternehmens in der Business Console.
  Er wird nur gespeichert, wenn sich der Status tatsächlich ändert.
- Bei `BLOCKED`-Unternehmen werden alle neuen Sitzungen zur Unternehmensverifizierung (KYB) und alle neuen Transaktionen automatisch abgelehnt, auch wenn das Unternehmen als Gegenpartei auftritt.
- Gibt `business.status.updated` mit `previous_status` und `status` aus.
  Der Webhook enthält kein `reason`.## Durchsetzung| Status | Neue Sitzungen zur Unternehmensverifizierung (KYB) | Transaktionen mit diesem Unternehmen |
| - | - | - |
| `ACTIVE` | Normaler Ablauf | Normaler Ablauf |
| `FLAGGED` | Weitergeleitet an `IN_REVIEW` | Kann über Regeln automatisch eskaliert werden |
| `BLOCKED` | Automatisch abgelehnt | Automatisch abgelehnt |## BerechtigungenDas primäre Secret und [API-Schlüssel](https://docs.didit.me/de/console/api-keys.md) mit vollem Zugriff können diesen Endpoint immer aufrufen.
Ein API-Schlüssel mit benutzerdefiniertem Zugriff benötigt die Schreibberechtigung für **Unternehmen** (`businesses`).
Ein Schlüssel, der auf einzelne Workflows oder genehmigte Sitzungen beschränkt ist, kann diesen Endpoint nicht erreichen.Die [Rollen und Berechtigungen](https://docs.didit.me/de/console/roles-permissions.md) der Business Console legen fest, was ein Teammitglied in der Console tun darf.
Für Anfragen mit API-Schlüsseln werden sie nicht ausgewertet.## Verwandte Seiten- [Lebenszyklus der Entität](https://docs.didit.me/de/entities/lifecycle.md)
- [Unternehmens-Sperrliste](https://docs.didit.me/de/entities/businesses/blocklist.md)
- [Webhooks für Entitäten](https://docs.didit.me/de/entities/webhooks.md)


## OpenAPI

````yaml de/openapi-25.json PATCH /v3/businesses/{vendor_data}/update-status/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/update-status/:
    patch:
      tags:
        - Businesses
      summary: Unternehmensstatus aktualisieren
      description: >-
        Nur den Lebenszyklus-`status` eines Unternehmens umschalten: `ACTIVE`,
        `FLAGGED` oder `BLOCKED` (keine Sitzungsstatus). `BLOCKED` fügt die
        `vendor_data` zur System-Sperrliste hinzu; ein Wechsel weg von `BLOCKED`
        entfernt diesen Eintrag wieder. Jede Änderung wird in den Aktivitäten
        des Unternehmens mit dem optionalen `reason` erfasst. Das Senden des
        aktuellen Status ändert nichts und erfasst keinen `reason`. Der Webhook
        `business.status.updated` überträgt keinen `reason`.
      operationId: update_business_status
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            Ihre eindeutige Kennung für das Unternehmen (Freitext-String, KEINE
            UUID).
          example: company-123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/EntityStatusUpdateRequest'
                - type: object
                  properties:
                    reason:
                      type: string
                      nullable: true
                      maxLength: 1000
                      description: >-
                        Warum sich der Status geändert hat. Wird im
                        Statusänderungseintrag unter **Activity** des
                        Unternehmens in der Business Console erfasst, nur wenn
                        sich der Status tatsächlich ändert. Webhooks übertragen
                        dies nicht.
            examples:
              Flag:
                summary: Das Unternehmen zur Prüfung markieren
                value:
                  status: FLAGGED
              Block:
                summary: Unternehmen sperren (fügt es zur Systemsperrliste hinzu)
                value:
                  status: BLOCKED
              Reactivate:
                summary: Unternehmen reaktivieren
                value:
                  status: ACTIVE
              Block with reason:
                summary: Unternehmen sperren und Grund erfassen
                value:
                  status: BLOCKED
                  reason: Registry shows the company dissolved
      responses:
        '200':
          description: >-
            Unternehmensstatus aktualisiert. Vollständiger Unternehmensdatensatz
            zurückgegeben.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessDetailItem'
              examples:
                Blocked:
                  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: BLOCKED
                    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'
        '400':
          description: >-
            Fehlender oder ungültiger `status` oder ein `reason` mit mehr als
            1000 Zeichen.
          content:
            application/json:
              examples:
                Missing status:
                  value:
                    status:
                      - This field is required.
                Bad status:
                  value:
                    status:
                      - >-
                        Invalid status. Valid options are: ACTIVE, FLAGGED,
                        BLOCKED
                Reason too long:
                  value:
                    reason:
                      - Ensure this field has no more than 1000 characters.
        '403':
          description: >-
            Fehlender, ungültiger oder widerrufener API-Schlüssel, oder der
            Schlüssel kann keine Unternehmen für diese Anwendung aktualisieren.
            Ein fehlender Schlüssel gibt `403` zurück; ein falscher,
            widerrufener oder abgelaufener Schlüssel gibt `401` zurück.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Für diese Anwendung existiert kein (nicht gelöschtes) Unternehmen
            mit den angegebenen `vendor_data`.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Rate-Limit überschritten; drosseln Sie die Anfragen und wiederholen
            Sie den Versuch nach dem in `Retry-After` angegebenen Intervall.
          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 PATCH
            'https://verification.didit.me/v3/businesses/company-123/update-status/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"status": "BLOCKED"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.businesses.update_status(
                "company-123",
                status="FLAGGED",
            )
            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.updateStatus("company-123", {
              status: "FLAGGED",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.UpdateStatus(ctx, \"company-123\", didit.BusinessesUpdateStatusParams{\n\tStatus: \"FLAGGED\",\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.BusinessesUpdateStatusParams;

            import me.didit.types.EntityStatusUpdateRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result = client.businesses().updateStatus("company-123",
            BusinessesUpdateStatusParams.builder()
                    .status(EntityStatusUpdateRequest.Status.of("FLAGGED"))
                    .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->updateStatus('company-123', [
                'status' => 'FLAGGED',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.businesses.update_status(
              "company-123",
              status: "FLAGGED"
            )
            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.UpdateStatusAsync("company-123", new
            BusinessesUpdateStatusParams

            {
                Status = "FLAGGED",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    EntityStatusUpdateRequest:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Neuer Lebenszyklusstatus. `BLOCKED` fügt die `vendor_data` außerdem
            zur System-Sperrliste hinzu.
    BusinessDetailItem:
      type: object
      description: >-
        Vollständige Unternehmensdetails. Erweitert BusinessListItem um
        Metadaten und updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                Benutzerdefiniertes Metadaten-JSON, das Sie diesem Unternehmen
                angehängt haben. Standardmäßig `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: Ein verifiziertes Unternehmen.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: Didits stabile interne UUID für dieses Unternehmen.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Ihre eindeutige Kennung für dieses Unternehmen (beim Erstellen von
            Sitzungen übergeben). Dies kann null sein, wenn keine Vendor-Kennung
            angegeben wurde.
        display_name:
          type: string
          nullable: true
          description: Von Ihnen festgelegter benutzerdefinierter Anzeigename
        legal_name:
          type: string
          nullable: true
          description: >-
            Offizieller juristischer Name aus dem Register oder manueller
            Eingabe
        registration_number:
          type: string
          nullable: true
          description: Unternehmensregister- oder Gründungsnummer
        country_code:
          type: string
          nullable: true
          description: Gründungsland (ISO 3166-1 Alpha-2, z. B. `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Bester verfügbarer Name: display_name, falls gesetzt, andernfalls
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Lebenszyklusstatus des Unternehmensdatensatzes (KEIN
            Sitzungsstatus). `ACTIVE` ist der Standard, `FLAGGED` markiert ihn
            für manuelle Prüfung, `BLOCKED` verhindert neue Sitzungen für dieses
            `vendor_data`.
        session_count:
          type: integer
          description: Gesamtzahl der Verifizierungssitzungen für dieses Unternehmen
        approved_count:
          type: integer
          description: Anzahl der genehmigten Sitzungen
        declined_count:
          type: integer
          description: Anzahl der abgelehnten Sitzungen
        in_review_count:
          type: integer
          description: Anzahl der Sitzungen in Prüfung
        features:
          type: object
          description: >-
            Aggregierter Status pro Funktion über alle KYB-Sitzungen dieses
            Unternehmens hinweg. Derzeit ist der einzige Schlüssel `KYB` (der
            Status der Unternehmensprüfung im Register). Mögliche Werte:
            `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub
            Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Dieselben Daten wie `features`, als geordnetes Array von `{feature,
            status}`-Objekten.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Zeitstempel der letzten Sitzung
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Zeitstempel der ersten Sitzung
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Zeitstempel der letzten Aktivität (Statusänderung,
            Sitzungsaktualisierung usw.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Diesem Unternehmen zugewiesene Tags
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in
        der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter
        Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese-
        oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte
        Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und
        auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen
        oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde,
        der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder
        die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei
        einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows
        oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff
        erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
        Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als
        null. Siehe https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.