> ## 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 actualitzar l'estat d'empresa: bloquejar o marcar

> Bloqueja, marca o activa una empresa (KYB) a Didit. L'estat s'aplica a les futures sessions KYB i al cribratge de transaccions. Pagament per crida.



Prompt d'actualització de l'estat de l'empresa
        Copia el prompt al porta-retalls



      
      

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



      
      

Enganxa a

## Descripció generalCanvia una [entitat empresarial](https://docs.didit.me/ca/entities/businesses/overview.md) entre `ACTIVE`, `FLAGGED` i `BLOCKED`. Consulta el [cicle de vida de l'entitat](https://docs.didit.me/ca/entities/lifecycle.md) per veure la màquina d'estats completa.## Quan s'ha d'utilitzar- **Bloquejar** una empresa sancionada o amb frau confirmat.
- **Marcar** una empresa pendent de revisió manual.
- **Desbloquejar** una empresa després de les mesures correctores.
- **Propagar senyals externs** des dels teus propis sistemes de compliment.## Notes- Valors vàlids: `ACTIVE`, `FLAGGED`, `BLOCKED`.
- Pots passar un `reason` opcional (fins a 1000 caràcters) per registrar el motiu del canvi d'estat.
  Didit el guarda a l'entrada del canvi d'estat a **Activitat** de l'empresa a la Business Console.
  Només es registra quan l'estat canvia de veritat.
- Les empreses `BLOCKED` tenen totes les sessions noves de verificació d'empreses (KYB) rebutjades automàticament i totes les transaccions noves rebutjades automàticament, també quan apareixen com a contrapart.
- Emet `business.status.updated` amb `previous_status` i `status`.
  El webhook no inclou `reason`.## Aplicació| Estat | Sessions noves de verificació d'empreses (KYB) | Transaccions que involucren aquesta empresa |
| - | - | - |
| `ACTIVE` | Flux normal | Flux normal |
| `FLAGGED` | Redirigida a `IN_REVIEW` | Pot escalar automàticament segons les regles |
| `BLOCKED` | Rebutjada automàticament | Rebutjada automàticament |## PermisosLa clau secreta principal i les [claus d'API](https://docs.didit.me/ca/console/api-keys.md) amb accés complet sempre poden cridar aquest endpoint.
Una clau amb accés personalitzat necessita permís d'escriptura per a **Empreses** (`businesses`).
Una clau limitada a alguns fluxos de treball o només a sessions aprovades no pot accedir a aquest endpoint.Els [rols i permisos](https://docs.didit.me/ca/console/roles-permissions.md) de la Console determinen què pot fer un membre de l'equip a la Console.
No s'avaluen per a les sol·licituds amb clau d'API.## Relacionat- [Cicle de vida de l'entitat](https://docs.didit.me/ca/entities/lifecycle.md)
- [Llista de bloqueig d'empreses](https://docs.didit.me/ca/entities/businesses/blocklist.md)
- [Webhooks de l'entitat](https://docs.didit.me/ca/entities/webhooks.md)


## OpenAPI

````yaml ca/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 de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/update-status/:
    patch:
      tags:
        - Businesses
      summary: Actualitza l'estat de l'empresa
      description: >-
        Canvia només el `status` del cicle de vida d'una empresa: `ACTIVE`,
        `FLAGGED` o `BLOCKED` (no els estats de sessió). `BLOCKED` afegeix el
        `vendor_data` a la llista de bloqueig del sistema; sortir de `BLOCKED`
        elimina aquesta entrada. Cada canvi es registra a l'activitat de
        l'empresa, amb el `reason` opcional. Enviar l'estat actual no canvia res
        ni registra cap `reason`. El webhook `business.status.updated` no inclou
        el `reason`.
      operationId: update_business_status
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            El teu identificador únic per a l'empresa (cadena de text lliure, NO
            un 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: >-
                        Per què ha canviat l'estat. Es registra a l'entrada de
                        canvi d'estat de l'apartat **Activitat** de l'empresa a
                        la Business Console, només quan l'estat canvia realment.
                        Els webhooks no l'inclouen.
            examples:
              Flag:
                summary: Marca l'empresa per a revisió
                value:
                  status: FLAGGED
              Block:
                summary: >-
                  Bloquejar l'empresa (s'afegeix a la llista de bloqueig del
                  sistema)
                value:
                  status: BLOCKED
              Reactivate:
                summary: Reactivar l'empresa
                value:
                  status: ACTIVE
              Block with reason:
                summary: Bloquejar l'empresa i registrar-ne el motiu
                value:
                  status: BLOCKED
                  reason: Registry shows the company dissolved
      responses:
        '200':
          description: >-
            Estat de l'empresa actualitzat. Es retorna el registre complet de
            l'empresa.
          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: >-
            Falta l'`status` o no és vàlid, o el `reason` supera els 1000
            caràcters.
          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: >-
            Clau d'API absent, no vàlida o revocada, o bé la clau no pot
            actualitzar empreses per a aquesta aplicació. Una clau absent
            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.
        '404':
          description: >-
            No existeix cap empresa (no eliminada) amb el `vendor_data`
            proporcionat per a aquesta aplicació.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '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 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: >-
            Nou estat del cicle de vida. `BLOCKED` també afegeix el
            `vendor_data` a la llista de bloqueig del sistema.
    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.