User

Usuarios #

Consultar usuario #

Consulta la información de un usuario específico. Este método le permitirá retornar el objeto de datos asociados al perfil del usuario, su historial de transacciones, saldo activo en la cuenta y datos relacionados a su perfilamiento crediticio dentro del ecosistema.

Las consultas de información al método requieren el envío de uno de los siguientes campos como valor requerido en la solicitud, id, nit o número telefónico registrado del usuario.

Para consultar información de un usuario es importante contar con el registro de éste en un ecosistema de manera previa o haber sido registrado por tu entidad. Consulte la guía relacionada Crear usuario.

Ejemplo

GET /user

https://www.api.sandbox-middleware.leancore.co/user?id=f9bb9fd7-a45f-445c-966d-1bb5d2e3dbad
o
https://www.api.sandbox-middleware.leancore.co/user?nit=10000000
o también
https://www.api.sandbox-middleware.leancore.co/user?phone=3010000000

Resultado

{
    "address": "string",
    "business_name": "string",
    "email": "string",
    "history": [
        { }
    ],
    "id": "string",
    "image": "string",
    "name": "string",
    "nit": "string",
    "payment_data": { },
    "phone": "string",
    "quota": 0,
    "score": 0,
    "status": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Crear usuario #

Crea un nuevo usuario en el ledger. Permite a tu fintech tener las facultades para dar asignación de un producto de crédito o cargar saldos en la cuenta del usuario creado. Devuelve como respuesta la información del nuevo usuario.

Ejemplo

POST /create-user

{
    "address": "string",
    "business_name": "string",
    "email": "string",
    "image": "string",
    "name": "string",
    "nit": "string",
    "phone": "string",
    "quota": 0,
    "score": 0,
    "status": "string"
}

Resultado

{
    "address": "string",
    "apn_token": "string",
    "business_name": "string",
    "email": "string",
    "history": [
        { }
    ],
    "id": "string",
    "image": "string",
    "name": "string",
    "nit": "string",
    "payment_data": { },
    "phone": "string",
    "quota": 0,
    "score": 0,
    "status": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Agregar cupo #

Agrega un saldo en la cuenta de un usuario específico enviando en la solicitud la información que representará la asignación del cupo en la cuenta del usuario como, tipo de crédito a generar, fecha de pago y cantidad de saldo real a reflejar en la transacción.

Use el método enviando el id o nit del cliente registrado como valores requeridos para asignar de manera correcta la operación. Retornará un error si hubo un fallo en la información proporcionada, por ejemplo, omitir el campo requerido o la información que definirá la transacción a asignar.

La asignación de cuota en las cuentas de sus clientes sólo se verá reflejada para aquellos de los que se tiene un registro en el ecosistema o creación por tu entidad de forma previa. Consulte la guía relacionada Crear usuario.

Ejemplo

POST /add-quota

{
    "amount": "string",
    "financial_entity_id": "string",
    "id": "string",
    "loan_type": "string",
    "nit": "string",
    "payment_date": "string"
}

Resultado

{
    "message": "string",
    "response": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Descargar cupo #

Descarga saldo en la cuenta de un usuario específico a través de una solicitud con id o nit del cliente como valor requerido y cantidad a descontar. Retornará un mensaje de confirmación si el cliente enviado se encuentra registrado y con saldo real asignado a su cuenta.

Ejemplo

POST /discharge-quota

{
    "amount": "string",
    "id": "string",
    "nit": "string"
}

Resultado

{
    "message": "string",
    "response": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Actualizar usuario #

Permite la actualización de datos de un usuario a través de una solicitud con id del cliente y nuevos valores de parámetros a modificar. Retornará el objeto del cliente si los valores proporcionados fueron válidos.

Los valores válidos para definir el status son, active cuando este se encuentre activo a su entidad financiera, arrear si el cliente no ha realizado el último pago de su crédito, default si el cliente se encuentra en mora de pago en un determinado tiempo.

Ejemplo

POST /update-user

{
    "address": "string",
    "bussines_name": "string",
    "email": "string",
    "history": [
        { }
    ],
    "id": "string",
    "image": "string",
    "name": "string",
    "nit": "string",
    "payment_data": { },
    "phone": "string",
    "score": 0,
    "status": "string"
}

Resultado

{
    "address": "string",
    "bussines_name": "string",
    "email": "string",
    "history": [
        { }
    ],
    "id": "string",
    "image": "string",
    "name": "string",
    "nit": "string",
    "payment_data": { },
    "phone": "string",
    "quota": 0,
    "score": 0,
    "status": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>