Saltar al contingut principal
PATCH
curl

Visió general

Actualitza els camps modificables d’una entitat Business. Els camps omplerts a partir de consultes al registre (legal_name, registration_number, country_code) passen a ser de només lectura després de la primera sessió de Verificació d’empreses (KYB) aprovada.

Quan utilitzar-lo

  • Canvia el nom: estableix un display_name més clar per a les vistes internes.
  • Actualitza les metadades: mou una empresa entre nivells interns, registra una nota interna o canvia les etiquetes.
  • Sobreescriu les dades del registre (amb precaució): les sobreescriptures s’accepten però queden marcades al registre d’auditoria.

Notes

  • vendor_data de la URL no es pot canviar amb aquest endpoint.
  • Emet un webhook business.data.updated amb una matriu changed_fields.
  • Cada edició queda registrada a Activitat de l’empresa a la Business Console. Un canvi de status es registra amb el reason opcional (fins a 1000 caràcters), i un canvi a display_name, legal_name, registration_number, country_code o metadata es registra com a actualització del perfil. El webhook business.status.updated no inclou reason.

Permisos

La clau secreta principal i les claus d’API amb accés complet sempre poden cridar aquest endpoint. Una clau amb accés personalitzat necessita permís d’escriptura sobre 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 de la Business 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

Autoritzacions

x-api-key
string
header
requerit

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.

Paràmetres de ruta

vendor_data
string
requerit

El teu identificador únic per a l'empresa (cadena de text lliure, NO un UUID).

Cos

application/json

Cos d'actualització parcial. Proporciona només els camps que vulguis canviar.

display_name
string | null

Nom descriptiu que es mostra a la consola (té prioritat sobre legal_name per a la visualització a la interfície d'usuari).

Nom legal oficial obtingut del registre mercantil o introduït manualment.

registration_number
string | null

Número de registre o de constitució de l'empresa.

country_code
string | null

País de constitució (ISO 3166-1 alpha-2, p. ex. GB, US).

status
enum<string>

Estat del cicle de vida de l'empresa. En establir BLOCKED, s'afegeix automàticament el valor de vendor_data a la llista de bloqueig del sistema; en canviar de BLOCKED a un altre estat, s'elimina aquesta entrada de la llista de bloqueig.

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

Objecte JSON arbitrari que adjuntes a l'empresa. Substitueix completament les metadades existents en actualitzar; fusiona-les al costat del client si només vols afegir claus.

reason
string | null

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.

Maximum string length: 1000

Resposta

Empresa actualitzada. Es retorna el registre complet i actualitzat de l'empresa.

Detall complet de l'empresa. Amplia BusinessListItem amb metadades i updated_at.

didit_internal_id
string<uuid>

UUID intern estable de Didit per a aquesta empresa.

vendor_data
string | null

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

Nom visible personalitzat definit per tu

Nom legal oficial obtingut del registre mercantil o introduït manualment

registration_number
string | null

Número de registre o de constitució de l'empresa

country_code
string | null

País de constitució (ISO 3166-1 alpha-2, p. ex. GB, US).

effective_name
string | null

Millor nom disponible: display_name si està definit, en cas contrari legal_name

status
enum<string>

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.

Opcions disponibles:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Nombre total de sessions de verificació per a aquesta empresa

approved_count
integer

Nombre de sessions aprovades

declined_count
integer

Nombre de sessions rebutjades

in_review_count
integer

Nombre de sessions en revisió

features
object

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

Les mateixes dades que features, com una llista ordenada d'objectes {feature, status}.

last_session_at
string<date-time> | null

Marca de temps de la sessió més recent

first_session_at
string<date-time> | null

Marca de temps de la primera sessió

last_activity_at
string<date-time> | null

Marca de temps de l'activitat més recent (canvi d'estat, actualització de la sessió, etc.)

tags
object[]

Etiquetes assignades a aquesta empresa

created_at
string<date-time>
metadata
object

JSON de metadades personalitzades que has adjuntat a aquesta empresa. Per defecte és {}.

updated_at
string<date-time>
Darrera modificació el 7 de novembre del 2026