Creación de Cuentas (Intents)

La creación de una cuenta comercio se inicializa mediante la creación de una Intención de Registro (Intent). Este proceso genera una sesión temporal y segura.

Crear Intent de Onboarding

Genera una URL única para que el comercio cliente complete su afiliación.

Endpoint: api/v1/onboarding/intent
Método: POST

Parámetros

Campo	Tipo	Obligatorio	Descripción	Máx. carácteres
success_url	string	No	A dónde redirigir al comercio cuando termine el registro.	2048
cancel_url	string	No	A dónde redirigir si el comercio cancela el proceso.	2048
metadata	object	No	Datos extra que querás guardar con este registro (ej. vendedor_id, region).	-
idempotency_key	string	No	Clave única para evitar crear registros duplicados por error.	64
metadata.business	object	No	Datos del negocio. Ver Datos del negocio.	-

Datos del negocio

Enviá estos datos cuando ya los tengas disponibles. Al ser campos opcionales, si no se incluyen, el comercio podrá completarlos posteriormente desde el formulario.

Campo	Tipo	Requerido	Descripción	Máx. chars
name	string	Sí	Nombre comercial (ej: "Café Central").	255
type	string	Sí	Nombre del sector/rubro del negocio. Ver Listado de Sectores.	255
whatsapp_number	string	Sí	Número de WhatsApp de Bolivia. Formatos: +59171558262, 59171558262, 71558262.	10
email	string	No	Correo electrónico de contacto.	255
location	string	Sí	Coordenadas en formato "latitud,longitud" (ej: "-17.7833,-63.1821"). Acepta con o sin espacio.	-
city	string	Sí	Ciudad. Ver Ciudades válidas.	255
address	string	Sí	Dirección completa.	300
billing	object	Sí	Datos de facturación. Ver Datos de facturación.	-
owner	object	Sí	Datos del propietario del negocio. Ver Datos del propietario.	-

Datos de facturación

Campo	Tipo	Requerido	Descripción	Máx. chars
business_name	string	Sí	Razón social o nombre legal.	255
document_number	string	Sí	NIT o CI.	40
document_type	string	Sí	"1" para CI o "5" para NIT.	-

Datos del propietario

Campo	Tipo	Requerido	Descripción	Máx. chars
name	string	Sí	Nombre del propietario.	255
first_last_name	string	Condicional	Primer apellido. Requerido si no enviás el segundo.	255
second_last_name	string	Condicional	Segundo apellido. Requerido si no enviás el primero.	255
ci	string	Sí	Número de Cédula de Identidad.	15
ci_complement	string	No	Complemento del CI (ej: "A1", "B2").	2 (exacto)

nota

El campo type debe contener exactamente el nombre del sector retornado por el endpoint GET api/v1/sectors.

Ciudades válidas

Código	Ciudad
1	La Paz
2	Oruro
3	Cochabamba
4	Santa Cruz
5	Potosí
6	Beni
7	Tarija
8	Sucre
9	Pando
10	Chuquisaca

Ejemplo: Solo datos básicos

El comercio completa sus datos desde el formulario de Vendis.

{
  "idempotency_key": "codeunique-intent",
  "success_url": "https://tu-sistema.com/onboarding/exito",
  "metadata": {
    "vendedor_id": "V-123",
    "region": "Santa Cruz"
  }
}

Ejemplo: Con datos del negocio

El comercio se registra directamente y queda pendiente de pago.

{
  "idempotency_key": "codeunique-intent",
  "success_url": "https://tu-sistema.com/onboarding/exito",
  "metadata": {
    "vendedor_id": "V-123",
    "business": {
      "name": "Café Central",
      "type": "Restaurante",
      "whatsapp_number": "70000000",
      "email": "info@cafecentral.com",
      "location": "-17.7833,-63.1821",
      "city": "Santa Cruz",
      "address": "Av. Principal #456",
      "billing": {
        "business_name": "Café Central S.R.L.",
        "document_number": "1029384756",
        "document_type": "5"
      },
      "owner": {
        "name": "Juan",
        "first_last_name": "Pérez",
        "second_last_name": "López",
        "ci": "1234567",
        "ci_complement": "LP"
      }
    }
  }
}

Respuesta

Sin datos del negocio (el comercio los completa después):

{
  "success": true,
  "data": {
    "code": "ONB-XXXX-XXXX",
    "status": "pending",
    "onboarding_url": "https://onboarding.vendis.com/start/onb_abcdef123...",
    "expires_at": "2026-04-24T15:51:00Z",
    "idempotency_key": "codeunique-intent"
  }
}

Con datos del negocio (pendiente de pago):

{
  "success": true,
  "data": {
    "code": "ONB-XXXX-XXXX",
    "status": "awaiting_payment",
    "onboarding_url": "https://onboarding.vendis.com/start/onb_abcdef123...",
    "expires_at": "2026-04-24T15:51:00Z",
    "metadata": {
      "vendedor_id": "V-123",
      "business": {
        "name": "Café Central",
        "type": "Restaurante",
        "whatsapp_number": "70000000",
        "email": "info@cafecentral.com",
        "location": "-17.7833,-63.1821",
        "city": "Santa Cruz",
        "address": "Av. Principal #456",
        "billing": {
          "business_name": "Café Central S.R.L.",
          "document_number": "1029384756",
          "document_type": "5"
        },
        "owner": {
          "name": "Juan",
          "first_last_name": "Pérez",
          "second_last_name": "López",
          "ci": "1234567",
          "ci_complement": "LP"
        }
      }
    },
    "idempotency_key": "codeunique-intent"
  }
}