Passer au contenu principal
PATCH
curl

Vue d’ensemble

Met à jour les champs modifiables d’une entité Business. Les champs renseignés à partir de recherches dans les registres (legal_name, registration_number, country_code) deviennent en lecture seule après la première session de Vérification d’entreprise (KYB) approuvée.

Quand l’utiliser

  • Renommer : définissez un meilleur display_name pour les vues internes.
  • Mettre à jour les métadonnées : faites passer une entreprise d’un niveau interne à un autre, enregistrez une note interne, modifiez les étiquettes.
  • Remplacer les données du registre (avec prudence) : les remplacements sont acceptés mais signalés dans le journal d’audit.

Remarques

  • vendor_data dans l’URL ne peut pas être modifié via cet endpoint.
  • Émet un webhook business.data.updated avec un tableau changed_fields.
  • Chaque modification est enregistrée dans l’Activité de l’entreprise dans la Business Console. Un changement de status est enregistré avec le reason facultatif (jusqu’à 1000 caractères), et un changement de display_name, legal_name, registration_number, country_code ou metadata est enregistré comme une mise à jour de profil. Le webhook business.status.updated ne transporte pas reason.

Autorisations

La clé secrète principale et les clés API à accès complet peuvent toujours appeler cet endpoint. Une clé à accès personnalisé doit disposer de l’autorisation d’écriture 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 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

Autorisations

x-api-key
string
header
requis

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.

Paramètres de chemin

vendor_data
string
requis

Votre identifiant unique pour l'entreprise (chaîne libre, PAS un UUID).

Corps

application/json

Corps de la requête de mise à jour partielle. Ne fournissez que les champs que vous souhaitez modifier.

display_name
string | null

Nom d'affichage convivial affiché dans la console (prend le pas sur legal_name pour l'affichage de l'interface utilisateur).

Raison sociale officielle issue du registre ou saisie manuelle.

registration_number
string | null

Numéro d'immatriculation ou de constitution de l'entreprise.

country_code
string | null

Pays de constitution (ISO 3166-1 alpha-2, par ex. GB, US).

status
enum<string>

Statut du cycle de vie de l'entreprise. Définir BLOCKED ajoute automatiquement le vendor_data à la liste de blocage du système ; quitter BLOCKED supprime cette entrée de la liste de blocage.

Options disponibles:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Objet JSON arbitraire que vous associez à l'entreprise. Remplace complètement les métadonnées existantes lors de la mise à jour — fusionnez côté client si vous souhaitez uniquement ajouter des clés.

reason
string | null

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.

Maximum string length: 1000

Réponse

Entreprise mise à jour. L'enregistrement complet et mis à jour de l'entreprise est renvoyé.

Détails complets de l'entreprise. Étend BusinessListItem avec métadonnées et updated_at.

didit_internal_id
string<uuid>

UUID interne stable de Didit pour cette entreprise.

vendor_data
string | null

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
string | null

Nom d'affichage personnalisé défini par vous

Raison sociale officielle issue du registre ou saisie manuelle

registration_number
string | null

Numéro d'immatriculation ou de constitution de l'entreprise

country_code
string | null

Pays de constitution (ISO 3166-1 alpha-2, par ex. GB, US).

effective_name
string | null

Meilleur nom disponible : display_name s'il est défini, sinon legal_name

status
enum<string>

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.

Options disponibles:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Nombre total de sessions de vérification pour cette entreprise

approved_count
integer

Nombre de sessions approuvées

declined_count
integer

Nombre de sessions refusées

in_review_count
integer

Nombre de sessions en cours d'examen

features
object

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
object[]

Mêmes données que features, sous la forme d'un tableau ordonné d'objets {feature, status}.

last_session_at
string<date-time> | null

Horodatage de la session la plus récente

first_session_at
string<date-time> | null

Horodatage de la première session

last_activity_at
string<date-time> | null

Horodatage de l'activité la plus récente (changement de statut, mise à jour de la session, etc.)

tags
object[]

Tags attribués à cette entreprise

created_at
string<date-time>
metadata
object

JSON de métadonnées personnalisées que vous avez associé à cette entreprise. La valeur par défaut est {}.

updated_at
string<date-time>
Dernière modification le 7 novembre 2026