Skip to main content

ark:MortgageAccount

idurirequired

URI format identifier used to refer to this node within the graph.

Example: https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000
typestringrequired

A type identifier used to indicate the data model that the node conforms to.

Constant value: ark:MortgageAccount
Example: ark:MortgageAccount
accountNumberstringrequired
FinancialGDPR

You can normally find this on a statement or welcome letter.

Possible values: non-empty

accountProviderurirequired
Example: https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000
appliesTourirequired
Example: https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000
illustrationuri

The illustration contains details on the payments and interest rates. Adding the document to Onteric will speed everything up, but we can estimate using a statement if you don't have one.

Example: https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000
loanAmount object
FinancialGDPR

The initial loan amount.

type
Constant value: ark:CurrencyValue
amountstringrequired

Possible values: Value must match regular expression ^[0-9]{1,}(\.[0-9]{2})?$

currencystringrequired

Possible values: Value must match regular expression ^[A-Z]{3}$

directionstring

Possible values: [Credit, Debit]

numberOfPaymentsinteger

The total number of payments over the term of the mortgage.

Possible values: >= 1

Example: 300
startedOndate

We'll start calculating interest from this date.

endedOndate

Adding a settled date will remove this account from being included in calculations. If you're remortgaging, set the date once your old mortgage provider has received the money for the balance.

ark:MortgageAccount
{
  "id": "https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "type": "ark:MortgageAccount",
  "accountNumber": "string",
  "accountProvider": "https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "appliesTo": "https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "illustration": "https://graph.onteric.com/.draft-nodes/f85b8b6b37fe3e8b144829d200000000",
  "loanAmount": {
    "amount": "string",
    "currency": "string",
    "direction": "Credit"
  },
  "numberOfPayments": 300,
  "startedOn": "2024-07-29",
  "endedOn": "2024-07-29"
}