Skip to content

User

Profile

Store Data

Store additional information to a user

  • Method: PUT
  • Path: /api/finux/user/profile
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected request

{
    "businessID":   "string",
    "uitrackingid": "string",
    "company":      "string",
    "firstname":    "string",
    "surename":     "string",
    "language":     "string",
    "employCounter":"string",
    "settings":     "interface"
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}

fetch data

Returns user profile information

  • Method: GET
  • Path: /api/finux/user/profile
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": {
            "businessID":   "string",
            "uitrackingid": "string",
            "firstname":    "string",
            "surename":     "string",
            "company":      "string",
            "language":     "string",
            "employCounter":"string",
            "settings":     "interface"
    }
}

Account

logout user

  • Method: POST
  • Path: /api/finux/user/logout
  • Header: X-Fino-ClientID : clientID and X-Fino-ClientSecret : token

expected request:

{
  "refreshToken": "string"
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

change password

Changes the password for a logged in user

  • Method: POST
  • Path: /api/finux/user/change-password
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected request:

{
    "oldPassword": "string",
    "newPassword": "string",
    "repeatPassword": "string"
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}

reset password

Sends a password reset email to user

  • Method: POST
  • Path: /api/finux/user/reset-password
  • Header: X-Fino-ClientID : clientID and X-Fino-ClientSecret : token

expected request:

{
    "email": "user@email.de", // mandatory
    "lifespan": 3600, // optional, range: 0-86400, default: 43200
    "redirect_uri": "https://app.FINUX.ui" // optional
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}

verify email

Sends a verify email to user

  • Method: POST
  • Path: /api/finux/user/verifyemail
  • Header: X-Fino-ClientID : clientID and X-Fino-ClientSecret : token

expected request:

{
    "email": "user@email.de", // mandatory
    "lifespan": 3600, // optional, range: 0-86400, default: 43200
    "redirect_uri": "https://app.FINUX.ui" // optional
}

always expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

clear user

  • Method: POST
  • Path: /api/finux/user/clear
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected request:

{
    "password": "string"
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "data": null,
    "code": 200
}

delete user

Delete user

  • Method: DELETE
  • Path: /api/finux/user/delete
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected request:

{
    "password": "string"
}

expected response:

{
    "status": {
        "message": "User deleted"
    },
    "data": null,
    "code": 200
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}

Feedback

Post Feedback

Writes feedback to our support-team. User will be get answered via SmartAlerts.

  • Method: POST
  • Path: /api/finux/user/feedback
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected request:

{
    "message": "string",
    "reply": false     
}

☝️ Do you want a reply via SmartAlerts? - Then it's true!

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}