Kuenta Docs

Appearance

Solicitar recuperación de contraseña​

POST
/auth/password/request

Inicia el proceso de recuperación de contraseña enviando un código de verificación por SMS, llamada o WhatsApp.

Funcionalidades principales:

  • Recuperación de contraseña: Inicia el proceso de reset de contraseña/PIN
  • Múltiples canales: Soporta envío por SMS, llamada y WhatsApp
  • Service Metering: Registra el uso del servicio para facturación
  • Soporte para registro: Permite indicar si es para registro de usuario nuevo

Flujo de recuperación:

  1. Solicitar código: Este endpoint para enviar código de recuperación
  2. Recibir código: Usuario recibe código por el canal elegido
  3. Verificar código: Usar /auth/password/verify para validar código
  4. Restablecer: Usar /auth/password/reset para establecer nueva contraseña

Casos de uso:

  • Olvidé mi PIN: Usuario no recuerda su PIN de 4 dígitos
  • Registro de usuario: Verificar teléfono durante proceso de registro
  • Cambio de contraseña: Verificar identidad antes de permitir cambio
  • Reactivación de cuenta: Recuperar acceso a cuentas bloqueadas

Seguridad:

  • Rate limiting por IP y número de teléfono
  • Service metering para evitar uso abusivo
  • Códigos con expiración temporal limitada

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",
"register": false
}

Responses​

Código de recuperación 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 de recuperación enviado exitosamente",
"sent_to": "+123****7890",
"via": "sms",
"expires_in": 300,
"next_step": "verify_code"
}

Playground​

Server
Authorization
Body

Samples​

Powered by VitePress OpenAPI