Kuenta Docs

Appearance

Solicitar código TOTP por SMS​

POST
/auth/totp/request

Solicita el envío de un código TOTP (Time-based One-Time Password) por SMS para verificación.

Funcionalidades principales:

  • Envío de TOTP: Genera y envía código de verificación por SMS
  • Múltiples vías: Soporta envío por SMS y otros canales configurados
  • Service Metering: Registra el uso del servicio para facturación
  • Rate Limiting: Previene spam y uso abusivo

Casos de uso:

  • Verificación de teléfono: Confirmar números de teléfono nuevos
  • Autenticación adicional: Segundo factor de autenticación
  • Recuperación de cuenta: Verificar identidad para cambios críticos
  • Procesos de registro: Validar teléfonos durante onboarding

Seguridad:

  • Códigos de un solo uso con expiración (5-10 minutos)
  • Rate limiting por IP y número de teléfono
  • Registro de auditoría con service metering
  • Prevención de números internacionales no válidos

Authorizations​

test

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://test-api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones
or
stage

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://stage-api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones
or
demo

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://demo-api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones
or
prod

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones

Request Body​

application/json
JSON
{
"phone": "+1234567890",
"via": "sms"
}

Responses​

Código TOTP enviado exitosamente. El código de verificación ha sido enviado al número especificado por el canal elegido.
application/json
JSON
{
"status": "string",
"message": "Código TOTP enviado exitosamente",
"sent_to": "+123****7890",
"via": "sms",
"expires_in": 300
}

Playground​

Server
Authorization
Body

Samples​

Powered by VitePress OpenAPI