This is a preview version of the API intended for early testing and integration. Preview versions are not stable and may include breaking changes before general availability.

Mortgage

Mortgage ("Bolån")

companystring

Company where the financial product has been collected from. Examples: se-folksam, se-lansforsakringar, se-avanza, se-movestic, se-spp, se-nordea, se-amf, se-seb, se-alecta, se-nordnet, se-handelsbanken, se-futur, se-swedbank, se-skandia, se-ica-bank, se-danske-bank.

companyDisplayNamestring

Display name of the company for user-friendly presentation.

financedObjectstring

The security of the loan

firstDrawDownDatestring

The date the loan was paid out

idstring

Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., productNumber, accountNumber, or loanId) for that.

interestInterest

interestBindingPeriodstring

The period during which the interest is fixed

Possible Enum values are THREE_MONTHS, ONE_YEAR, TWO_YEARS, THREE_YEARS, FOUR_YEARS, FIVE_YEARS, SEVEN_YEARS, EIGHT_YEARS, TEN_YEARS or UNKNOWN.

loanDetailsLoanDetails

loanIdstring

The id of the loan from the source

nextPaymentNextPayment

ownersArray<LoanOwner>

repaymentScheduleRepaymentSchedule

statusstring

Possible Enum values are IN_PROGRESS, PAID_UP, CANCELLED or UNKNOWN.

typestring

Type of the financial product.

Possible Enum values are KF, ISK, CUSTODY_ACCOUNT, UNKNOWN_INVESTMENT_TYPE, IPS_PENSION, PRIVATE_PENSION, OCCUPATIONAL_PENSION, COLLECTIVE_OCCUPATIONAL_PENSION, UNKNOWN_PENSION_TYPE, MORTGAGE_LOAN, UNSECURED_LOAN, GENERAL_SAVINGS_ACCOUNT, GENERAL_SAVINGS_ACCOUNT_FIXED_PERIOD, PSD2_SAVINGS_ACCOUNT, PSD2_CHECKING_ACCOUNT or PSD2_CREDIT_CARD.

Example

{
  "company": "se-company",
  "companyDisplayName": "Company",
  "financedObject": "BRF EKORRHOLKEN 32",
  "firstDrawDownDate": "2020-02-29",
  "id": "6a7c135e-3a56-44ae-bc53-1d0d5321f552",
  "interest": {
    "baseRate": 0.0512,
    "discount": 0.012,
    "discountEndDate": "2025-03-31",
    "effectiveRate": 0.0398,
    "periodStartDate": "2024-07-01",
    "rate": 0.0392,
    "rateAdjustmentDate": "2024-10-01"
  },
  "interestBindingPeriod": "TWO_YEARS",
  "loanDetails": {
    "balance": {
      "amount": 2000000,
      "currency": "SEK"
    },
    "granted": {
      "amount": 3000000,
      "currency": "SEK"
    },
    "paid": {
      "amount": 1000000,
      "currency": "SEK"
    }
  },
  "loanId": "000047433123",
  "nextPayment": {
    "date": "2024-09-28",
    "instalment": {
      "amount": 5000,
      "currency": "SEK"
    },
    "interest": {
      "amount": 7784,
      "currency": "SEK"
    },
    "total": {
      "amount": 12784,
      "currency": "SEK"
    }
  },
  "owners": [
    {
      "name": "Karl Ekorrströmberg",
      "sharePercentage": 1
    }
  ],
  "repaymentSchedule": {
    "finalDebt": 0,
    "finalPaymentDate": "2070-09-28",
    "numberOfInstalments": 50,
    "repaymentDayOfMonth": 30
  },
  "status": "IN_PROGRESS",
  "type": "MORTGAGE_LOAN"
}

{  "company": "se-company",  "companyDisplayName": "Company",  "financedObject": "BRF EKORRHOLKEN 32",  "firstDrawDownDate": "2020-02-29",  "id": "6a7c135e-3a56-44ae-bc53-1d0d5321f552",  "interest": {    "baseRate": 0.0512,    "discount": 0.012,    "discountEndDate": "2025-03-31",    "effectiveRate": 0.0398,    "periodStartDate": "2024-07-01",    "rate": 0.0392,    "rateAdjustmentDate": "2024-10-01"  },  "interestBindingPeriod": "TWO_YEARS",  "loanDetails": {    "balance": {      "amount": 2000000,      "currency": "SEK"    },    "granted": {      "amount": 3000000,      "currency": "SEK"    },    "paid": {      "amount": 1000000,      "currency": "SEK"    }  },  "loanId": "000047433123",  "nextPayment": {    "date": "2024-09-28",    "instalment": {      "amount": 5000,      "currency": "SEK"    },    "interest": {      "amount": 7784,      "currency": "SEK"    },    "total": {      "amount": 12784,      "currency": "SEK"    }  },  "owners": [    {      "name": "Karl Ekorrströmberg",      "sharePercentage": 1    }  ],  "repaymentSchedule": {    "finalDebt": 0,    "finalPaymentDate": "2070-09-28",    "numberOfInstalments": 50,    "repaymentDayOfMonth": 30  },  "status": "IN_PROGRESS",  "type": "MORTGAGE_LOAN"}