API · Actívate con Telcel
Da de alta trámites desde tu herramienta
v0.368.0 versión documentada · última comprobación con las pruebas automáticas de la puerta: 0.371.0 · actualizada el 2026-10-26
Una API para dar de alta un trámite de línea nueva o portabilidad en Actívate con Telcel, etapa por etapa, y seguir su avance. Tú entregas el expediente; Actívate lo revisa y lo hace avanzar.
https://api-activate.brainsuite.mx/v1/sites/zomAuthorization: Bearer. Permisos write y access, por separado.00Qué cubre esta documentación
| Cubre | Una sola API: la puerta de alta de trámite de Actívate con Telcel. Son 10 operaciones para crear un trámite de línea nueva o portabilidad, completarlo por etapas, subir las fotos de la INE y seguir su avance. |
|---|---|
| No cubre | Las demás rutas del servicio (panel, atención conversacional, reportes), que no son para integraciones externas. Tampoco migración, cambio de plan ni avisos de vuelta. |
| Otros servicios | Esta página no documenta otras APIs. Si antes de crear el trámite validas la INE con un servicio de validación de documentos, mandas su identificador en validacion_previa al crear el trámite: es evidencia, no veredicto, porque Actívate corre su propia revisión. La documentación de ese servicio te la entrega Actívate con Telcel aparte. |
| Qué usar | Guía: cómo integrarte, paso a paso. Contrato: lo normativo; manda si hay diferencia. Referencia y openapi.yaml: la forma legible por máquina. |
01El recorrido, en ocho pasos
Una etapa por llamada y en este orden. Cada respuesta trae el trámite completo, con next_step y pendientes para saber qué falta. Repetir una etapa la sobrescribe; no duplica nada.
- AltaCrea el trámite con tu referencia, consentimiento y contacto.POST /leads
- Camino y líneaLínea nueva o portabilidad, y el número.PATCH plan_linea
- PlanPlan y modalidad (opcional si ya los mandaste).PATCH plan
- DatosNombre, domicilio, correo y teléfono adicional.PATCH datos
- Fotos de la INEFrente y reverso, con tu referencia de archivo.POST documents/{kind}
- ReferenciasDos personas, con teléfonos distintos.PATCH referencias
- NIPSolo portabilidad, con las fotos ya subidas.PATCH portabilidad
- SeguimientoConsulta el estado con intervalo.GET estado
02Mapa de rutas
| Método | Ruta | Qué hace | Permiso |
|---|---|---|---|
| POST | /leads | Crear el trámite | write |
| PATCH | /leads/{folio}/plan_linea | Camino (línea nueva o portabilidad) y línea | write |
| PATCH | /leads/{folio}/plan | Plan y modalidad | write |
| PATCH | /leads/{folio}/datos | Nombre, correo, domicilio y teléfono adicional | write |
| PATCH | /leads/{folio}/referencias | Dos referencias | write |
| PATCH | /leads/{folio}/portabilidad | NIP (portabilidad) o ICCID | write |
| POST | /leads/{folio}/documents/{kind} | Subir una cara de la INE | write |
| GET | /leads/{folio}/estado | Estado público del trámite | access |
| GET | /leads/{folio}/documents | Expediente de documentos | access |
| GET | /leads/{folio}/identificadores | Lectura de la foto del chip y de la pantalla | access |
| GET | /plans | Catálogo de planes (sin autenticación) | — |
| GET | /health | Liveness y versión, en la raíz del dominio (sin autenticación) | — |
No existe, para una herramienta, listar trámites, buscar por tu referencia, cancelar ni recibir avisos de vuelta: guarda el folio que devuelve el alta y consulta con intervalo.
03Tu primera llamada
Primero comprueba que tu alta funciona. Sin token debe responder 401; con tu token, sobre un folio que no existe, 404: es la señal de que autenticaste y tienes permiso.
T=https://api-activate.brainsuite.mx/v1/sites/zom
curl -s -o /dev/null -w "%{http_code}\n" $T/leads/ZZ000000/estado # 401
curl -s -o /dev/null -w "%{http_code}\n" -H "Authorization: Bearer $PLANES_PUERTA_TOKEN" $T/leads/ZZ000000/estado # 404
Después, crea un trámite de prueba. referencia_externa es tu id de negocio y la llave de idempotencia: si el POST no respondió, repítelo idéntico y recibes el mismo folio.
curl -s -X POST "$T/leads" -H "Authorization: Bearer $PLANES_PUERTA_TOKEN" -H "Content-Type: application/json" -d '{
"source": "herramienta",
"referencia_externa": "prueba-000123",
"clase": "prueba",
"consent": { "basis": "aviso_aceptado", "evidence": { "aceptado_at": "2026-10-22T09:00:00-06:00", "canal": "app_socio" } },
"contact_name": "Juan Pérez López",
"contact_phone": "5500000921",
"plan_ref": "libre-1"
}'
Antes de probar
Un trámite de prueba es simulado: no crea el alta automática ni consulta al operador por la foto. Aun así, el expediente se guarda y se analiza, y al quedar validado Actívate publica una copia de las fotos de la INE en una dirección con código aleatorio, también en pruebas. Usa únicamente datos y fotos ficticios. Para probar sin riesgo, pide a Actívate con Telcel un consumidor de prueba: detalle y límites en la guía, modo de prueba.
04Errores y reintentos
Los errores llegan como { "error": "CODIGO", "message"?, "field"? }: ramifica por error, nunca por message. Los 401 traen texto libre y se ramifican por el status.
| Status | Qué hacer |
|---|---|
| 401 403 | Revisa el token y su permiso. No se reintenta: tres 401 seguidos son una alerta. |
404 LEAD_NOT_FOUND | Folio inexistente, de otro dueño, o llamaste sin declarar herramienta. El mensaje es idéntico a propósito. |
| 409 422 | Corrige el dato (field te dice cuál). En 409 TRAMITE_ABIERTO el cuerpo trae el folio: continúa desde ahí. |
| 429 | Espera. TOPE_DIARIO trae Retry-After; RATE_LIMITED no: baja el ritmo. |
| 500 503 | Reintenta con espera creciente (1, 2, 4, 8 s; 3 a 5 intentos). Las altas y las subidas (con X-Adjunto-Ref) son idempotentes. |
Catálogo completo por ruta en la guía, errores.
05Documentos para descargar
Los tres documentos de esta página, tal como se publican. Si algo difiere entre ellos, manda el contrato.
SHA-256 81eacccf37ceae3adf6716261705ac90fcc8dcf63b4d6b18aad04021ebe6c5a3 Contrato de la puertaLa especificación normativa. Markdown.contrato.md · 29.9 kB
SHA-256 11117c12b5fe9c5b00d8d19bf32d2218bcdf9e812ae6bd35ff88a42ca4927319 openapi.yamlOpenAPI 3.1, 10 operaciones. Para generar clientes o importar a tus herramientas.openapi.yaml · 53.3 kB
SHA-256 3a98ac63391c4360ec25c7ebad69879c8b485e470e011f95ef7c16525a321392