What to tell the user
Share goals and figures to request demo access. The information is saved and can be updated through a private email link while the person waits for approval. A reusable demo invitation grants access directly, with independent saved information for each participant.
Generate my analysis currently saves the approved person’s confirmation only. Analysis generation is not connected yet; this flow sends no information to an AI provider and starts no calculations. Do not promise a completed result, personal review or call from submitting the form.
Prefill the local form
Only do this when the user asks you to. Ask for estimates where needed; leave unknown figures blank. Exclude identifiers, passwords, account numbers, exact addresses and documents.
A prefill link opens the form with draft answers. Values are removed from the address bar after the form reads them. The user should check and correct the answers. The person reviews the form and chooses Request demo access to save it. Do not grant acknowledgements or submit on their behalf. Demo access is by approval or invitation; analysis generation is not connected yet.
For example, for a made-up household:
https://planeir.ie/apply/#topics=mortgage%2Cretirement&unsure=mortgage.repayment%2Cpensions.1.dbPension&question=How+would+overpaying+our+mortgage+compare+with+increasing+pension+contributions%3F&upcoming=Our+fixed+rate+ends+in+June+2027.&household.age=41&household.partner=yes&household.partnerAge=39&household.married=yes&household.children=yes&children.0.age=9&children.1.age=6&income.gross=62000&income.basis=gross&income.partnerGross=48000&income.partnerBasis=gross&income.work=employee&income.partnerWork=employee&income.sector=private&income.partnerSector=public&spending.pattern=save&spending.saved=700&home.status=mortgage&home.value=420000&mortgage.balance=240000&mortgage.rate=3.9&mortgage.rateType=fixed&mortgage.fixedEnds=2027-06&mortgage.yearsLeft=23&savings.cash=18000&pensions.0.owner=you&pensions.0.type=company&pensions.0.value=85000&pensions.0.youPay=5&pensions.0.youPayUnit=pct&pensions.0.employerPays=5&pensions.0.employerPaysUnit=pct&pensions.0.contributing=yes&pensions.1.owner=partner&pensions.1.type=public&retirement.age=65&retirement.partnerAge=63
Question guide
The fields below come from the same schema as the form. The information schema describes fields, not permission to submit. The API description currently contains no submission operations.
Your question
Shown for every application.
| Question | Field | Answer |
|---|
| What do you want to understand? |
question |
Text, up to 2000 characters. Private workspace information. |
| Is anything coming up, and when? |
upcoming |
Text, up to 600 characters. Private workspace information. |
| What would a good outcome look like? |
goodOutcome |
Text, up to 1000 characters. Private workspace information. |
| What worries you most? |
worries |
Text, up to 1000 characters. Private workspace information. |
About you
Shown for every application. Ages set the timelines for pensions, mortgages and college.
| Question | Field | Answer |
|---|
| Your age |
household.age |
A whole number from 18 to 100. |
| Are you planning with a partner? |
household.partner |
One of: "yes" (Yes), "no" (No). |
| Your partner’s age |
household.partnerAge |
A whole number from 16 to 100. Only when household.partner is "yes". |
| Are you married or in a civil partnership? |
household.married |
One of: "yes" (Yes), "no" (No). Only when household.partner is "yes". |
| Do you have children? |
household.children |
One of: "yes" (Yes), "no" (No). |
Children
Shown for when household.children is "yes". Their ages show when college costs start and how long they depend on you.
| Question | Field | Answer |
|---|
| Age |
children[].age |
A whole number from 0 to 30. |
| College plans |
children[].collegePlan |
One of: "away" (Away from home), "home" (From home), "unsure" (Not sure yet). Only when topics include "education" or "whole". |
| Saved for them so far |
children[].saved |
A number in euro, like 35000. Only when topics include "education" or "whole". |
Income
Shown for every application. Income sets your tax, your pension relief and what a lender will offer.
| Question | Field | Answer |
|---|
| Your pay a year |
income.gross |
A number in euro a year, like 35000. |
| Your partner’s pay a year |
income.partnerGross |
A number in euro a year, like 35000. Only when household.partner is "yes". |
| Your work |
income.work |
One of: "employee" (Employee), "self_employed" (Self-employed), "director" (Company director), "not_working" (Not working), "retired" (Retired). |
| Your partner’s work |
income.partnerWork |
One of: "employee" (Employee), "self_employed" (Self-employed), "director" (Company director), "not_working" (Not working), "retired" (Retired). Only when household.partner is "yes". |
| Your sector |
income.sector |
One of: "public" (Public sector), "private" (Private sector). Only when income.work is "employee". |
| Your partner’s sector |
income.partnerSector |
One of: "public" (Public sector), "private" (Private sector). Only when household.partner is "yes" and income.partnerWork is "employee". |
Spending and saving
Shown for every application. This shows how much room there is each month.
| Question | Field | Answer |
|---|
| Most months, do you |
spending.pattern |
One of: "save" (Save some), "even" (Break even), "more" (Spend more than you earn). |
| Roughly how much you save a month |
spending.saved |
A number in euro a month, like 35000. Only when spending.pattern is not "even" or "more". |
| What you spend a month, not counting rent or mortgage |
spending.spend |
A number in euro a month, like 35000. |
Your home
Shown for every application. Your home and what it costs are part of the full picture.
| Question | Field | Answer |
|---|
| Your home |
home.status |
One of: "mortgage" (Own with a mortgage), "owned" (Own outright), "rent" (Rent), "family" (Live with family). |
| What it would sell for today |
home.value |
A number in euro, like 35000. Only when home.status is "mortgage" or "owned". |
| Rent a month |
home.rent |
A number in euro a month, like 35000. Only when home.status is "rent". |
Mortgage
Shown for when home.status is "mortgage". Your rate and years left decide what overpaying would save.
| Question | Field | Answer |
|---|
| Balance left |
mortgage.balance |
A number in euro, like 35000. |
| Interest rate |
mortgage.rate |
A percentage as a number, like 4.2 (up to 30). |
| Rate type |
mortgage.rateType |
One of: "tracker" (Tracker), "variable" (Variable), "fixed" (Fixed). |
| When the fixed rate ends |
mortgage.fixedEnds |
Year and month, like 2027-03. Only when mortgage.rateType is "fixed". |
| Margin above the ECB rate |
mortgage.trackerMargin |
A percentage as a number, like 4.2 (up to 10). Only when mortgage.rateType is "tracker". |
| Years left |
mortgage.yearsLeft |
A number of years, like 22 or 22.5. |
| Repayment a month |
mortgage.repayment |
A number in euro a month, like 35000. |
| Are you overpaying now? |
mortgage.overpaying |
One of: "yes" (Yes), "no" (No). |
| Overpayment a month |
mortgage.overpayment |
A number in euro a month, like 35000. Only when mortgage.overpaying is "yes". |
| Lender |
mortgage.lender |
Text, up to 60 characters. Private workspace information. |
Buying a home
Shown for topics: buying (or any answers given). A lender looks at the price, your deposit and your income.
| Question | Field | Answer |
|---|
| Price you are looking at |
buying.price |
A number in euro, like 35000. |
| First-time buyer? |
buying.firstTime |
One of: "yes" (Yes), "no" (No). |
| Deposit saved so far |
buying.deposit |
A number in euro, like 35000. |
| Approval in principle, if you have one |
buying.approval |
A number in euro, like 35000. |
| Using Help to Buy or the First Home scheme? |
buying.scheme |
One of: "yes" (Yes), "no" (No), "unsure" (Not sure). |
| When would you like to buy? |
buying.when |
One of: "6m" (Within 6 months), "12m" (6 to 12 months), "24m" (1 to 2 years), "later" (Later). |
Savings and investments
Shown for every application. Savings show what is there for goals and emergencies.
| Question | Field | Answer |
|---|
| Cash in the bank, all accounts |
savings.cash |
A number in euro, like 35000. |
| Investments and shares |
savings.investments |
A number in euro, like 35000. |
| Shares in your employer |
savings.employerShares |
A number in euro, like 35000. |
Other property
Shown for topics: whole (or any answers given). Rental or holiday property you own apart from your home. If none apply, put "properties" in none.
| Question | Field | Answer |
|---|
| Value |
properties[].value |
A number in euro, like 35000. |
| Mortgage on it |
properties[].mortgage |
A number in euro, like 35000. |
| Rent a year |
properties[].rent |
A number in euro a year, like 35000. |
| Costs a year, not counting mortgage interest |
properties[].costs |
A number in euro a year, like 35000. |
| Mortgage interest rate |
properties[].rate |
A percentage as a number, like 4.2 (up to 30). |
Pensions
Shown for topics: retirement, mortgage, whole (or any answers given). Your pension statement has most of these. If none apply, put "pensions" in none.
| Question | Field | Answer |
|---|
| Whose pension |
pensions[].owner |
One of: "you" (Yours), "partner" (Your partner’s). Only when household.partner is "yes" (otherwise the pension is the applicant's). |
| Type |
pensions[].type |
One of: "company" (Company pension), "public" (Public service or defined benefit), "prsa" (PRSA), "personal" (Personal pension), "bond" (Buy-out bond from an old job), "unsure" (Not sure). |
| Value today |
pensions[].value |
A number in euro, like 35000. Only when type is not "public". |
| Personal contribution |
pensions[].youPay |
A number: a percentage of salary like 5, or euro a month with youPayUnit set to "eur". Only when type is "company", "prsa", "personal" or "unsure". |
| Employer contribution |
pensions[].employerPays |
A number: a percentage of salary like 5, or euro a month with employerPaysUnit set to "eur". Only when type is "company", "prsa" or "unsure". |
| Still paying in? |
pensions[].contributing |
One of: "yes" (Yes), "no" (No). Only when type is "company", "prsa", "personal" or "unsure". |
| Expected pension a year |
pensions[].dbPension |
A number in euro a year, like 35000. Only when type is "public". |
| Expected lump sum |
pensions[].dbLumpSum |
A number in euro, like 35000. Only when type is "public". |
| From what age |
pensions[].dbAge |
A whole number from 50 to 75. Only when type is "public". |
Planning details
Shown for topics: whole, retirement, mortgage, loans, education, savings (or any answers given). These optional details help turn your confirmed figures into an illustration. Leave anything unknown blank.
| Question | Field | Answer |
|---|
| Are you single, widowed or separated? |
planning.taxStatus |
One of: "single" (Single), "widowed_or_surviving_civil_partner" (Widowed or surviving civil partner), "separated" (Separated). Only when household.partner is "no". |
| Does your spending figure exclude transfers to savings? |
planning.savingSeparate |
One of: "yes" (Yes), "no" (No). |
Retirement
Shown for topics: retirement, whole (or any answers given). These set the target the projection works towards.
| Question | Field | Answer |
|---|
| Age you would like to stop working |
retirement.age |
A whole number from 40 to 80. |
| Age your partner would like to stop working |
retirement.partnerAge |
A whole number from 40 to 80. Only when household.partner is "yes". |
| Income you would like a year in retirement, in today’s money |
retirement.income |
A number in euro a year, like 35000. |
| Your State Pension |
retirement.statePension |
One of: "yes" (Full), "partly" (Partial), "none" (None), "unsure" (Not sure). |
| Your years paying PRSI in Ireland so far |
retirement.prsiYearsWorked |
A number of years, like 22 or 22.5. Only when retirement.statePension is partial or not sure. |
| Your years at home caring |
retirement.prsiYearsCaring |
A number of years, like 22 or 22.5. Only when retirement.statePension is partial or not sure. |
| Until you stop working, will you mostly be… |
retirement.prsiFutureWork |
One of: "ireland" (Mostly working in Ireland), "abroad" (Mostly working abroad), "not_working" (Mostly not working). Only when retirement.statePension is partial or not sure. |
| Your partner’s State Pension |
retirement.partnerStatePension |
One of: "yes" (Full), "partly" (Partial), "none" (None), "unsure" (Not sure). Only when household.partner is "yes". |
| Your partner’s years paying PRSI in Ireland so far |
retirement.partnerPrsiYearsWorked |
A number of years, like 22 or 22.5. Only when partner present and retirement.partnerStatePension is partial or not sure. |
| Your partner’s years at home caring |
retirement.partnerPrsiYearsCaring |
A number of years, like 22 or 22.5. Only when partner present and retirement.partnerStatePension is partial or not sure. |
| Until your partner stops working, will your partner mostly be… |
retirement.partnerPrsiFutureWork |
One of: "ireland" (Mostly working in Ireland), "abroad" (Mostly working abroad), "not_working" (Mostly not working). Only when partner present and retirement.partnerStatePension is partial or not sure. |
Loans and credit cards
Shown for topics: loans, buying, whole (or any answers given). Repayments affect what you can save and what you can borrow. If none apply, put "loans" in none.
| Question | Field | Answer |
|---|
| Do you clear your credit card in full each month? |
creditCard.clears |
One of: "yes" (Yes), "no" (No), "none" (No credit card). |
| Credit card balance |
creditCard.balance |
A number in euro, like 35000. Only when creditCard.clears is "no". |
| Type |
loans[].type |
One of: "car" (Car), "personal" (Personal), "credit_union" (Credit union), "student" (Student), "other" (Other). |
| Balance |
loans[].balance |
A number in euro, like 35000. |
| Interest rate |
loans[].rate |
A percentage as a number, like 4.2 (up to 60). |
| Years left |
loans[].yearsLeft |
A number of years, like 22 or 22.5. |
| Payment a month |
loans[].payment |
A number in euro a month, like 35000. |
Cover
Shown for topics: whole (or any answers given). Cover that pays out if someone dies or cannot work.
| Question | Field | Answer |
|---|
| Life cover |
cover.life |
One of: "yes" (Yes), "no" (No), "unsure" (Not sure). |
| Income protection |
cover.incomeProtection |
One of: "yes" (Yes), "no" (No), "unsure" (Not sure). |
Anything else
Shown for every application.
| Question | Field | Answer |
|---|
| Anything else you want to add? |
anythingElse |
Text, up to 2000 characters. Private workspace information. |
Earlier applications
The former case-video application API is closed to new public requests. Earlier confirmation links and records remain part of that separate service under the original notice. Never convert publication permission into permission for a private workspace.
