/v3/businesses/. Esta página ofrece un recorrido conceptual; consulta la referencia de la API para ver los esquemas completos de solicitud y respuesta.
Listar empresas
GET /v3/businesses/
Lista paginada de las empresas de tu aplicación, con filtros por estado, búsqueda, país y rango de fechas.
Obtener una empresa
GET /v3/businesses/{vendor_data}/
Obtiene una única empresa por vendor_data.
Crear una empresa
POST /v3/businesses/create/
Crea por adelantado una empresa antes de que se ejecute cualquier sesión de verificación de empresas (KYB):
vendor_data. Usa PATCH para actualizar una empresa existente.
Actualizar una empresa
PATCH /v3/businesses/{vendor_data}/
Actualiza los campos modificables del perfil. Los campos obtenidos de consultas al registro (legal_name, registration_number, country_code) son de solo lectura tras la verificación, pero se pueden sobrescribir; las sobrescrituras quedan marcadas en el registro de auditoría.
Campos modificables: display_name, metadata, tags.
De solo lectura tras la verificación: todos los campos obtenidos del registro, los contadores agregados y el mapa features.
business.data.updated.
Cambiar el estado
PATCH /v3/businesses/{vendor_data}/update-status/
Cambia el estado de una empresa entre ACTIVE, FLAGGED y BLOCKED.
Emite
business.status.updated.
Eliminar empresas (por lotes)
POST /v3/businesses/delete/
Elimina una o varias empresas. Los registros de las empresas se eliminan de forma permanente. Sus sesiones de verificación no están cubiertas por este endpoint y se conservan, con su vínculo a la empresa eliminado; elimínalas con Delete Session. Las transacciones tampoco están cubiertas; elimínalas desde la consola.
Modelo de permisos
Todos los endpoints/v3/businesses/* están sujetos al recurso de permisos businesses:
Consulta Roles y permisos.
Webhooks activados por estas operaciones
Próximos pasos
Modelo de datos
Referencia completa de los campos.
API de listado
Esquema de GET /v3/businesses/.
API de creación
Esquema de POST /v3/businesses/create/.