GET /users/{id_or_external_id}/insights

Additional relevant financial insights of the consumer's financial profile

Path parameters

  • id_or_external_id string Required

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

Responses

  • 200

    User insights retrieved

    Hide response attributes Show response attributes object
    • estimated_total_expenditure number

      Estimated average monthly expenditures in currency.

    • recommended_savings_amount number

      Recommended savings amount (in currency) to cover "rainy days" or potential lays off.

    • savings_slack number

      Additional indication of an average amount/slack that consumer can set aside to invest or save on a different account for the future interest gains. Amount in currency e.g., kr.

    • best_savings_offer object

      For Norway only Displays the best offer from the market. Based on the finansportalen.

      Hide best_savings_offer attributes Show best_savings_offer attributes object
      • interest_rate number

        Savings account annual interest rate.

      • name string

        Accouunt or offer name

      • financial_institution object

        Financial institution description.

        Hide financial_institution attributes Show financial_institution attributes object
        • name string

          Name of a financial institution.

        • code string

          code name of a financial institution.
  • 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}/insights 
curl \
 -X GET https://link.goscore.me/finid-api/1.0/users/{id_or_external_id}/insights \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "estimated_total_expenditure": 15039.76,
  "recommended_savings_amount": 95600.0,
  "savings_slack": 42.0,
  "best_savings_offer": {
    "interest_rate": 0.045,
    "name": "Fastrentekonto",
    "financial_institution": {
      "name": "SVEA Finans",
      "code": "no-svea"
    }
  }
}
Response examples (200) 
{
  "estimated_total_expenditure": 15039.76,
  "recommended_savings_amount": 95600.0,
  "savings_slack": 42.0,
  "best_savings_offer": {
    "interest_rate": 0.045,
    "name": "Fastrentekonto",
    "financial_institution": {
      "name": "SVEA Finans",
      "code": "no-svea"
    }
  }
}
Response examples (500) 
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}
Response examples (500) 
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}