Iniciar sesión

POST

/auth/login

Autentica a un usuario en el sistema Kuenta utilizando número de teléfono y PIN de 4 dígitos.

Funcionalidades principales:

• Autenticación por PIN: Verificación con PIN numérico de 4 dígitos
• Autenticación multi-factor: Verificación por SMS cuando está habilitada
• Tokens JWT: Retorna access token y refresh token
• Información del perfil: Incluye datos del usuario y roles asignados
• Multi-organización: Soporte para usuarios con acceso a múltiples organizaciones

Flujo de autenticación:

1. Validación de credenciales: Verificar teléfono y PIN de 4 dígitos
2. Verificación de cuenta: Confirmar que la cuenta esté activa
3. Generación de tokens: Crear access token y refresh token
4. Retorno de perfil: Enviar información del usuario y roles

Seguridad:

• Implementa rate limiting para prevenir ataques de fuerza bruta
• Los tokens tienen tiempo de vida limitado (configurable por organización)
• Registra todos los intentos de login para auditoría
• Bloqueo temporal después de múltiples intentos fallidos
• PIN numérico de 4 dígitos para acceso rápido desde dispositivos móviles

Rate Limiting:

• Límite estándar: 10 intentos por minuto por IP
• Límite por teléfono: 5 intentos por hora por número de teléfono
• Bloqueo temporal: 15 minutos después de 5 intentos fallidos

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

Estructura exacta que usa el controlador

{

"phone": "+1234567890",

"password": "1234"

}

Responses

Autenticación exitosa. El usuario ha sido autenticado correctamente y se retornan los tokens de acceso junto con la información del perfil y roles asignados.

Content-Type

application/json

Respuesta típica para un usuario persona natural según estructura AuthAccess

{

"user": {

"id": "123e4567-e89b-12d3-a456-426614174000",

"email": "[email protected]",

"phone": "+1234567890",

"verifiedAt": "2023-01-15T10:30:00Z"

},

"profile": {

"entityID": "789e1234-e89b-12d3-a456-426614174001",

"type": "natural",

"isCopy": false,

"natural": {

"profileID": "123e4567-e89b-12d3-a456-426614174000",

"status": true,

"firstName": "Juan",

"lastName": "Pérez García",

"idType": 1,

"idNumber": "12345678",

"email": "[email protected]"

}

},

"roles": [

{

"id": "789e1234-e89b-12d3-a456-426614174002",

"name": "user",

"entityID": "789e1234-e89b-12d3-a456-426614174001",

"userID": "123e4567-e89b-12d3-a456-426614174000",

"permissions": [

"read:credits",

"create:credits"

]

}

],

"expiresIn": 3600

}

POST

/auth/login

Playground

Server

Authorization

test

Body

Samples

Powered by VitePress OpenAPI