GET /users/{id_or_external_id}/sustainability

Sustainabillity insights represents the financial indicators that reepresents consumer's financial sutiation at a glance. Can be tracked over time e.g. month-to-month to facilitate and reinforce new habits.

Path parameters

  • id_or_external_id string Required

    UUID or external ID of a user profile to get access to their reports, insights, and data.

Responses

  • 200

    Sustainability insights retrieved

    Hide response attributes Show response attributes object
    • barometer_score number

      Sustainability barometer: the score goes from -100 to 100 and plays as an overconsumption indicator. In other words, financial sustainabillity score. A single indicator of the financial performance. Negative score represents overconsumption. Positive score shows savings potential.

    • income_vs_expenses array[object]

      Display the 12-months chart to indicate the month-to-month total expenses and income.

      Hide income_vs_expenses attributes Show income_vs_expenses attributes array[object]
      • month string

        Month and year

      • income_total number

        Average monthly amouunt gained on the defined category group.

      • expenses_total number

        Average monthly amouunt spend on the defined category group.
  • 404

    User not found

  • 500

    The request is not valid.

    Hide response attributes Show response attributes object
    • error_message string

      Human readable error message.

    • error string

      Error code & short status
GET /users/{id_or_external_id}/sustainability 
curl \
 -X GET https://link.goscore.me/finid-api/1.0/users/{id_or_external_id}/sustainability \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "barometer_score": 42.0,
  "income_vs_expenses": [
    {
      "month": "Oct 2023",
      "income_total": 42.0,
      "expenses_total": 42.0
    }
  ]
}
Response examples (200) 
{
  "barometer_score": 42.0,
  "income_vs_expenses": [
    {
      "month": "Oct 2023",
      "income_total": 42.0,
      "expenses_total": 42.0
    }
  ]
}
Response examples (500) 
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}
Response examples (500) 
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}