Saltar al contenido principal
PATCH
curl

Descripción general

Actualiza los campos modificables de una empresa. Los campos que se rellenan a partir de consultas al registro (legal_name, registration_number, country_code) pasan a ser de solo lectura tras la primera sesión aprobada de Verificación de empresas (KYB).

Cuándo usarlo

  • Renombrar: define un display_name más adecuado para las vistas internas.
  • Actualizar metadatos: mueve una empresa entre niveles internos, registra una nota interna o cambia etiquetas.
  • Sobrescribir datos del registro (con precaución): las sobrescrituras se aceptan, pero quedan marcadas en el registro de auditoría.

Notas

  • El vendor_data de la URL no se puede cambiar mediante este endpoint.
  • Emite un webhook business.data.updated con un array changed_fields.
  • Cada edición queda registrada en la Activity de la empresa en la Business Console. Un cambio de status se registra con el reason opcional (hasta 1000 caracteres), y un cambio de display_name, legal_name, registration_number, country_code o metadata, como una actualización del perfil. El webhook business.status.updated no incluye reason.

Permisos

El secreto principal y las claves de API con acceso completo siempre pueden invocar este endpoint. Una clave con acceso personalizado necesita permiso de escritura en Empresas (businesses). Una clave limitada a algunos flujos o a sesiones aprobadas no puede acceder a este endpoint. Los roles y permisos de la Console determinan lo que un miembro del equipo puede hacer en la Console. No se evalúan en las solicitudes con clave de API.

Relacionado

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Parámetros de ruta

vendor_data
string
requerido

Tu identificador único de la empresa (cadena de texto libre, NO un UUID).

Cuerpo

application/json

Cuerpo de actualización parcial. Indica solo los campos que quieras cambiar.

display_name
string | null

Nombre visible descriptivo que se muestra en la consola (tiene prioridad sobre legal_name en la interfaz).

Razón social oficial obtenida del registro o introducida manualmente.

registration_number
string | null

Número de registro o de constitución de la empresa.

country_code
string | null

País de constitución (ISO 3166-1 alfa-2, p. ej., GB, US).

status
enum<string>

Estado del ciclo de vida de la empresa. Establecer BLOCKED añade automáticamente el vendor_data a la lista de bloqueo del sistema; cambiar de BLOCKED a otro estado elimina esa entrada de la lista de bloqueo.

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

Objeto JSON arbitrario que adjuntas a la empresa. Reemplaza por completo los metadatos existentes al actualizar: combínalos en el cliente si solo quieres añadir claves.

reason
string | null

Por qué cambió el estado. Se registra en la entrada de cambio de estado de Activity de la empresa en Business Console, solo cuando el estado cambia realmente. Los webhooks no lo incluyen.

Maximum string length: 1000

Respuesta

Empresa actualizada. Se devuelve el registro completo y actualizado de la empresa.

Detalle completo de la empresa. Amplía BusinessListItem con los metadatos y updated_at.

didit_internal_id
string<uuid>

UUID interno estable de Didit para esta empresa.

vendor_data
string | null

Tu identificador único de esta empresa (el que se envía al crear sesiones). Puede ser null si no se proporcionó ningún identificador propio.

display_name
string | null

Nombre visible personalizado que has definido

Razón social oficial obtenida del registro o introducida manualmente

registration_number
string | null

Número de registro o de constitución de la empresa

country_code
string | null

País de constitución (ISO 3166-1 alfa-2, p. ej., GB, US).

effective_name
string | null

Mejor nombre disponible: display_name si está definido; si no, legal_name

status
enum<string>

Estado del ciclo de vida del registro de la empresa (NO es un estado de sesión). ACTIVE es el valor predeterminado, FLAGGED lo marca para atención manual y BLOCKED impide nuevas sesiones para este vendor_data.

Opciones disponibles:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Número total de sesiones de verificación de esta empresa

approved_count
integer

Número de sesiones aprobadas

declined_count
integer

Número de sesiones rechazadas

in_review_count
integer

Número de sesiones en revisión

features
object

Estado agregado por función de todas las sesiones KYB de esta empresa. Actualmente la única clave es KYB (el estado de la comprobación de la empresa en el registro). Valores posibles: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Los mismos datos que features, como un array ordenado de objetos {feature, status}.

last_session_at
string<date-time> | null

Marca de tiempo de la sesión más reciente

first_session_at
string<date-time> | null

Marca de tiempo de la primera sesión

last_activity_at
string<date-time> | null

Marca de tiempo de la actividad más reciente (cambio de estado, actualización de la sesión, etc.)

tags
object[]

Etiquetas asignadas a esta empresa

created_at
string<date-time>
metadata
object

JSON de metadatos personalizados que adjuntaste a esta empresa. Valor predeterminado: {}.

updated_at
string<date-time>
Última modificación el 1 de noviembre de 2026