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

# Mise à jour du statut d'entreprise : bloquer ou signaler

> Bloquez, signalez ou activez une entreprise Didit (KYB). Le statut s'applique aux futures sessions KYB et au filtrage des transactions. Facturation à l'appel.



Prompt de mise à jour du statut d'entreprise
        Copier le prompt dans le presse-papiers



      
      

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



      
      

Coller dans

## Vue d'ensembleFait passer une [entité entreprise](https://docs.didit.me/fr/entities/businesses/overview.md) entre `ACTIVE`, `FLAGGED` et `BLOCKED`. Consultez le [cycle de vie de l'entité](https://docs.didit.me/fr/entities/lifecycle.md) pour la machine à états complète.## Quand l'utiliser- **Bloquer** une entreprise sanctionnée ou confirmée comme frauduleuse.
- **Signaler** une entreprise en attente d'un examen manuel.
- **Débloquer** une entreprise après remédiation.
- **Propager les signaux externes** issus de vos propres systèmes de conformité.## Remarques- Valeurs possibles : `ACTIVE`, `FLAGGED`, `BLOCKED`.
- Vous pouvez transmettre un `reason` facultatif (1000 caractères maximum) pour consigner la raison du changement de statut.
  Didit le conserve dans l'entrée de changement de statut, sous **Activité** de l'entreprise dans la Business Console.
  Il n'est enregistré que lorsque le statut change réellement.
- Les entreprises `BLOCKED` voient toutes leurs nouvelles sessions de vérification d'entreprise (KYB) refusées automatiquement, et toutes leurs nouvelles transactions refusées automatiquement, y compris lorsqu'elles apparaissent en tant que contrepartie.
- Émet `business.status.updated` avec `previous_status` et `status`.
  Le webhook ne contient pas `reason`.## Application| Statut | Nouvelles sessions de vérification d'entreprise (KYB) | Transactions impliquant cette entreprise |
| - | - | - |
| `ACTIVE` | Flux normal | Flux normal |
| `FLAGGED` | Redirigé vers `IN_REVIEW` | Peuvent être automatiquement escaladées par des règles |
| `BLOCKED` | Refusé automatiquement | Refusé automatiquement |## AutorisationsLa clé secrète principale et les [clés API](https://docs.didit.me/fr/console/api-keys.md) à accès complet peuvent toujours appeler cet endpoint.
Une clé à accès personnalisé a besoin de l'autorisation d'écriture sur **Entreprises** (`businesses`).
Une clé limitée à certains workflows ou à certaines sessions approuvées ne peut pas accéder à cet endpoint.Les [rôles et autorisations](https://docs.didit.me/fr/console/roles-permissions.md) de la Console déterminent ce qu'un membre de l'équipe peut faire dans la Console.
Ils ne sont pas évalués pour les requêtes effectuées avec une clé API.## Liens connexes- [Cycle de vie de l'entité](https://docs.didit.me/fr/entities/lifecycle.md)
- [Liste de blocage des entreprises](https://docs.didit.me/fr/entities/businesses/blocklist.md)
- [Webhooks d'entité](https://docs.didit.me/fr/entities/webhooks.md)


## OpenAPI

````yaml fr/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 vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/update-status/:
    patch:
      tags:
        - Businesses
      summary: Mettre à jour le statut de l'entreprise
      description: >-
        Basculer uniquement le `status` de cycle de vie d'une entreprise :
        `ACTIVE`, `FLAGGED` ou `BLOCKED` (pas les statuts de session). `BLOCKED`
        ajoute le `vendor_data` à la liste de blocage du système ; quitter
        l'état `BLOCKED` supprime cette entrée. Chaque modification est
        enregistrée dans l'activité de l'entreprise, avec le `reason`
        facultatif. Envoyer le statut actuel ne change rien et n'enregistre
        aucun `reason`. Le webhook `business.status.updated` ne transmet pas
        `reason`.
      operationId: update_business_status
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            Votre identifiant unique pour l'entreprise (chaîne libre, PAS 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: >-
                        Raison pour laquelle le statut a changé. Enregistrée sur
                        l'entrée de changement de statut dans **Activité** de
                        l'entreprise au sein de la Business Console, uniquement
                        lorsque le statut change réellement. Les webhooks ne la
                        transmettent pas.
            examples:
              Flag:
                summary: Signaler l'entreprise pour examen
                value:
                  status: FLAGGED
              Block:
                summary: Bloquer l'entreprise (ajoute à la liste de blocage du système)
                value:
                  status: BLOCKED
              Reactivate:
                summary: Réactiver l'entreprise
                value:
                  status: ACTIVE
              Block with reason:
                summary: Bloquer l'entreprise et consigner le motif
                value:
                  status: BLOCKED
                  reason: Registry shows the company dissolved
      responses:
        '200':
          description: >-
            Statut de l'entreprise mis à jour. L'enregistrement complet de
            l'entreprise est renvoyé.
          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: >-
            `status` manquant ou invalide, ou un `reason` de plus de 1000
            caractères.
          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: >-
            Clé API manquante, invalide ou révoquée, ou la clé ne peut pas
            mettre à jour d'entreprises pour cette application. Une clé
            manquante renvoie `403` ; une clé incorrecte, révoquée ou expirée
            renvoie `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Aucune entreprise (non supprimée) avec le `vendor_data` fourni
            n'existe pour cette application.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Limite de débit dépassée ; réduisez la cadence et réessayez après
            l'intervalle indiqué dans `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: >-
            Nouveau statut de cycle de vie. `BLOCKED` ajoute également le
            `vendor_data` à la liste de blocage du système.
    BusinessDetailItem:
      type: object
      description: >-
        Détails complets de l'entreprise. Étend BusinessListItem avec
        métadonnées et updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON de métadonnées personnalisées que vous avez associé à cette
                entreprise. La valeur par défaut est `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: Une entreprise vérifiée.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID interne stable de Didit pour cette entreprise.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Votre identifiant unique pour cette entreprise (transmis lors de la
            création des sessions). Peut être nul si aucun identifiant
            fournisseur n'a été fourni.
        display_name:
          type: string
          nullable: true
          description: Nom d'affichage personnalisé défini par vous
        legal_name:
          type: string
          nullable: true
          description: Raison sociale officielle issue du registre ou saisie manuelle
        registration_number:
          type: string
          nullable: true
          description: Numéro d'immatriculation ou de constitution de l'entreprise
        country_code:
          type: string
          nullable: true
          description: Pays de constitution (ISO 3166-1 alpha-2, par ex. `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: >-
            Meilleur nom disponible : display_name s'il est défini, sinon
            legal_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Statut de cycle de vie de l'enregistrement d'entreprise (PAS un
            statut de session). `ACTIVE` est la valeur par défaut, `FLAGGED` le
            signale pour un examen manuel, `BLOCKED` empêche de nouvelles
            sessions pour ce `vendor_data`.
        session_count:
          type: integer
          description: Nombre total de sessions de vérification pour cette entreprise
        approved_count:
          type: integer
          description: Nombre de sessions approuvées
        declined_count:
          type: integer
          description: Nombre de sessions refusées
        in_review_count:
          type: integer
          description: Nombre de sessions en cours d'examen
        features:
          type: object
          description: "Statut agrégé par fonctionnalité sur l'ensemble des sessions KYB de cette entreprise. Actuellement, la seule clé est `KYB` (le statut de vérification de l'entreprise au registre). Valeurs possibles\_: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`."
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Mêmes données que `features`, sous la forme d'un tableau ordonné
            d'objets `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Horodatage de la session la plus récente
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Horodatage de la première session
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Horodatage de l'activité la plus récente (changement de statut, mise
            à jour de la session, etc.)
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Tags attribués à cette entreprise
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clé API de votre application, issue de Développeurs -> Clés API dans
        la Business Console. La clé principale dispose d'un accès complet. Une
        clé nommée peut être restreinte : aucun, lecture ou écriture par
        ressource, limitée à certains workflows ou aux sessions approuvées, à
        une liste d'adresses IP et à une date d'expiration. 401 signifie que la
        clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a
        été envoyée, que la clé n'a pas accès à cette ressource ou action, ou
        que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur
        une route de session signifie que la session est hors des workflows ou
        des statuts de la clé. Une clé sans accès aux médias reçoit les URL
        d'images, de vidéos et de PDF à null, et une clé sans accès en écriture
        aux sessions reçoit les liens et tokens de session à null. Voir
        https://docs.didit.me/console/api-keys.

````

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