Skip to main content
Version: Latest

Paso 1 — Aceptar Términos y Condiciones

Registra la aceptación de los términos y condiciones del servicio y crea el registro inicial del cliente en AVE. Este es el primer paso del flujo y es obligatorio antes de continuar con los demás.

Request 🚀​

URL​

https://api.aveonline.co/api-onboarding/public/api/v1/external/onboarding/acceptTerms

Method​

POST

Headers​

Content-Type: application/json
Accept: application/json
Authorization: Bearer {tu_token_jwt}

Body JSON​

note

Los campos email y phone son mutuamente excluyentes. Debes enviar al menos uno de los dos.

Identificación (al menos uno requerido)​

  • email String email, max:255 — Requerido si no se envía phone
  • phone Numeric — Requerido si no se envía email

Campos opcionales​

  • name String min:6, max:255 — Nombre del cliente
  • phoneCode String — Indicativo del país. Ej: +57
  • numberShipments String — Volumen de envíos: 0-100 101-500 501-1000 +1000
  • ecommerce String — Plataforma ecommerce. Ej: Shopify
  • idCampaign String — ID de la campaña de origen
  • urlLeadSource String min:6, max:255 — URL de la fuente externa
  • keybe String max:255 — ID del contacto en Keybe
  • codeIso String max:255 — Código ISO del país. Ej: CO

Ejemplo de payload​

{
  "email": "juancarlos@empresa.com",
  "phone": "3108001234",
  "name": "Juan Carlos Perez",
  "phoneCode": "+57",
  "numberShipments": "0-100",
  "ecommerce": "Shopify"
}

Response​

201 — Términos registrados (lead nuevo)​

{
  "status": "ok",
  "message": "Lead created",
  "data": {
    "insertId": 110
  }
}

200 — Términos actualizados (lead existente)​

{
  "status": "ok",
  "message": "Lead updated",
  "data": {
    "rowsUpdated": 1
  }
}

211 — Ya tiene proceso en curso​

{
  "status": "ok",
  "message": "Its already boarding process",
  "data": {
    "seed": "994f9ccf-d22b-4cea-9565-3920d2ba2bbe"
  }
}

212 — Email ya existe como empresa​

{
  "errors": [
    {
      "title": "Error control",
      "detail": "The email already exists in Companies"
    }
  ]
}

422 — Error de validación​

{
  "errors": [
    {
      "title": "email",
      "detail": "email is required or email must be a valid email"
    }
  ]
}

Notas importantes​

  • Este paso puede ejecutarse de forma independiente (no requiere seed)
  • Si el cliente ya completó el Paso 4, la empresa ya está activa en AVE. Este paso simplemente registra la aceptación de los términos
  • Con esto el flujo de onboarding queda completamente finalizado ✅