Body

• transfer_type string Required

  Transfer type.

  Value	Description
  switch	Switch
  transfer	Transfer

  Values are switch or transfer.

• date_advice_given string(date) Required

  Date advice given

• amount integer Required

  Premium amount in pennies. Either amount or percentage can be given in request

• percentage number(float) Required

  Premium percentage of the plans pensionable salary. Either amount or percentage can be given in request

  Minimum value is 0.0, maximum value is 100.0.

• frequency string Required

  Premium frequency

  Value	Description
  daily	Daily
  weekly	Weekly
  fortnightly	Fortnightly
  four_weekly	Four Weekly
  monthly	Monthly
  bimonthly	Bimonthly
  quarterly	Quarterly
  biannually	Biannually
  annually	Annually
  adhoc	Adhoc
  one_off	One Off

  Values are daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc, or one_off.

• source string

  Premium source, only for pension plans.

  Value	Description
  employee	Employee
  employer	Employer

  Values are employee or employer.

• payment_method string Required

  Payment method.

  Value	Description
  salary_sacrifice	Salary Sacrifice
  salary_deduction	Salary Deduction
  direct_debit	Direct Debit
  standing_order	Standing Order
  cheque	Cheque
  bank_transfer	Bank Transfer

  Values are salary_sacrifice, salary_deduction, direct_debit, standing_order, cheque, or bank_transfer.

• start_date string(date) Required

  Start date

• end_date string(date)

  End date. Leave blank for ongoing

• details string

  Details

• transferred_from_plan_uuid string(uuid)

  The plan UUID this premium was transferred from

• transferred_from_plan_type string

  The plan type this premium was transferred from if the actual plan UUID is unknown

  Value	Description
  annuity	Annuity
  cash_account	Cash Account
  fixed_asset	Fixed Asset
  general_insurance	General Insurance
  group_protection	Group Protection
  investment	Investment
  loan_credit	Loan Credit
  mortgage	Mortgage
  pension	Pension
  protection_policy	Protection Policy

  Values are annuity, cash_account, fixed_asset, general_insurance, group_protection, investment, loan_credit, mortgage, pension, or protection_policy.

• transferred_from_plan_sub_type string

  The plan sub type this premium was transferred from if the actual plan UUID is unknown

  Value	Description
  cash_account	Cash Account
  cash_deposit	Cash Deposit
  isa_mini_cash	ISA (Mini Cash)
  isa_tessa_only	ISA (TESSA Only)
  lifetime_isa_cash	Lifetime ISA (Cash)
  national_savings	National Savings
  national_savings_child_bonus_bond	National Savings (Child Bonus Bond)
  national_savings_fixed_interest_certificate	National Savings (Fixed Interest Certificate)
  national_savings_guaranteed_equity_bond	National Savings (Guaranteed Equity Bond)
  national_savings_income_bond	National Savings (Income Bond)
  national_savings_index_linked_certificate	National Savings (Index Linked Certificate)
  national_savings_national_savings_certificate	National Savings (National Savings Certificate)
  national_savings_premium_bonds	National Savings (Premium Bonds)
  cash_account_unknown	Unknown
  aim_investment_tax_service	AIM Investment Tax Service
  bes	BES
  business_premises_renovation_allowance	Business Premises Renovation Allowance
  child_trust_fund	Child Trust Fund
  collective_investment_account	Collective Investment Account
  commercial_property_purchase_scheme	Commercial Property Purchase Scheme
  debenture	Debenture
  discretionary_managed_service	Discretionary Managed Service
  employee_benefit_trust	Employee Benefit Trust
  enterprise_investment_scheme_non_regulated	Enterprise Investment Scheme (Non-Regulated)
  enterprise_investment_scheme_regulated	Enterprise Investment Scheme (Regulated)
  enterprise_investment_zone_trust	Enterprise Investment Zone Trust
  enterprise_zone_syndicate	Enterprise Zone Syndicate
  equity_holdings	Equity Holdings
  exchange_traded_fund	Exchange Traded Fund
  exempt_property_unit_trust	Exempt Property Unit Trust
  film_partnership	Film Partnership
  geared_investments	Geared Investments
  general_investment_account	General Investment Account
  hedge_fund	Hedge Fund
  investment_bond	Investment Bond
  investment_tax_service	Investment Tax Service
  investment_trust	Investment Trust
  isa_aim	ISA (AIM)
  isa_cash	ISA (Cash)
  isa_help_to_buy	ISA (Help To Buy)
  isa_maxi	ISA (Maxi)
  isa_maxi_mini_transfer	ISA (Maxi/Mini Transfer)
  isa_mini_equity	ISA (Mini Equity)
  isa_nisa	ISA (Nisa)
  isa_stocks_and_shares	ISA (Stocks And Shares)
  junior_isa_cash	Junior ISA (Cash)
  junior_isa_nisa	Junior ISA (Nisa)
  junior_isa_stocks_and_shares	Junior ISA (Stocks And Shares)
  lifetime_isa_stocks_and_shares	Lifetime ISA (Stocks And Shares)
  maximum_investment_plan_investment	Maximum Investment Plan
  non_discretionary_managed_service	Non Discretionary Managed Service
  oeic_unit_trust	Oeic/Unit Trust
  offshore_bond	Offshore Bond
  offshore_deposit	Offshore Deposit
  offshore_oeic_fund	Offshore Oeic/Fund
  offshore_savings_plan	Offshore Savings Plan
  onshore_bond	Onshore Bond
  personal_equity_plan	Personal Equity Plan
  property_holdings	Property Holdings
  property_partnership	Property Partnership
  property_syndicate	Property Syndicate
  residential_property_development	Residential Property Development
  savings_account	Savings Account
  seed_enterprise_investment_scheme_non_regulated	Seed Enterprise Investment Scheme (Non-Regulated)
  seed_enterprise_investment_scheme_regulated	Seed Enterprise Investment Scheme (Regulated)
  share_incentive_plan	Share Incentive Plan
  share_save_scheme	Share Save Scheme
  sicav	SICAV
  structured_plan	Structured Plan
  structured_plan_cash_isa	Structured Plan (Cash ISA)
  structured_plan_deposit	Structured Plan (Deposit)
  structured_plan_medium_term_note	Structured Plan (Medium Term Note)
  structured_plan_stocks_shares_isa	Structured Plan (Stocks & Shares ISA)
  tessa	TESSA
  trust	Trust
  unit_trust	Unit Trust
  unregulated_collective_investments	Unregulated Collective Investments
  venture_capital_trust_non_regulated	Venture Capital Trust (Non-Regulated)
  venture_capital_trust_regulated	Venture Capital Trust (Regulated)
  wrap	Wrap
  investment_unknown	Unknown
  accident_and_sickness_insurance	Accident And Sickness Insurance
  accident_sickness_and_unemployment_insurance	Accident Sickness And Unemployment Insurance
  accidental_death_insurance	Accidental Death Insurance
  business_loan_protection	Business Loan Protection
  capital_redemption_policy	Capital Redemption Policy
  death_in_service	Death In Service
  endowment	Endowment
  flexible_plan	Flexible Plan
  general_insurance_income_protection	General Insurance (Income Protection)
  gift_inter_vivos	Gift Inter Vivos
  health_assessment	Health Assessment
  income_protection	Income Protection
  income_protection_executive	Income Protection (Executive)
  income_protection_key_person	Income Protection (Key Person)
  life_settlement_fund	Life Settlement Fund
  maximum_investment_plan	Maximum Investment Plan
  multi_benefit_protection	Multi Benefit Protection
  pension_contribution_insurance	Pension Contribution Insurance
  pension_term_assurance	Pension Term Assurance
  pre_paid_funeral_plan	Pre-Paid Funeral Plan
  redundancy_insurance	Redundancy Insurance
  relevant_life_policy	Relevant Life Policy
  renewable_convertible_term	Renewable Convertible Term
  term_protection	Term Protection
  term_protection_convertible	Term Protection (Convertible)
  term_protection_critical_illness	Term Protection (Critical Illness)
  term_protection_decreasing_term	Term Protection (Decreasing Term)
  term_protection_decreasing_term_ci	Term Protection (Decreasing Term - CI)
  term_protection_decreasing_term_life_ci	Term Protection (Decreasing Term - Life & CI)
  term_protection_directors_share_protection	Term Protection (Directors Share Protection)
  term_protection_family_income_protection	Term Protection (Family Income Protection)
  term_protection_family_income_protection_ci	Term Protection (Family Income Protection - CI)
  term_protection_family_income_protection_life_ci	Term Protection (Family Income Protection - Life & CI)
  term_protection_increasing_term	Term Protection (Increasing Term)
  term_protection_key_person_assurance	Term Protection (Key Person Assurance)
  term_protection_level	Term Protection (Level)
  term_protection_level_ci	Term Protection (Level - CI)
  term_protection_level_life_ci	Term Protection (Level - Life & CI)
  term_protection_mortgage_protection	Term Protection (Mortgage Protection)
  term_protection_partnership_protection	Term Protection (Partnership Protection)
  term_protection_renewable	Term Protection (Renewable)
  unemployment_insurance	Unemployment Insurance
  whole_of_life	Whole Of Life
  whole_of_life_non_investment	Whole Of Life (Non Investment)
  will	Will
  protection_policy_unknown	Unknown
  alternatively_secured_pension_plan	Alternatively Secured Pension Plan
  appropriate_personal_pension	Appropriate Personal Pension
  avc	AVC
  cimp	CIMP
  cimp_comp	CIMP & COMP
  comp	COMP
  deferred_sipp	Deferred SIPP
  defined_benefit_pension	Defined Benefit Pension
  dependants_pension	Dependants Pension
  efrbs	EFRBS
  equivalent_pension_benefits	Equivalent Pension Benefits
  executive_pension_plan	Executive Pension Plan
  family_sipp	Family SIPP
  final_salary_scheme	Final Salary Scheme
  fsavc	FSAVC
  furbs	FURBS
  group_cimp	Group CIMP
  group_comp	Group COMP
  group_dependants_pension	Group Dependants Pension
  group_offshore_pension_scheme	Group Offshore Pension Scheme
  group_personal_pension	Group Personal Pension
  group_s32_buyout_bond	Group S32 Buyout Bond
  group_sipp	Group SIPP
  group_stakeholder_pension	Group Stakeholder Pension
  income_drawdown_beneficiary	Income Drawdown (Beneficiary)
  income_drawdown_capped	Income Drawdown (Capped)
  income_drawdown_flexi_access	Income Drawdown (Flexi-Access)
  income_drawdown_flexible	Income Drawdown (Flexible)
  independent_retirement_advice	Independent Retirement Advice (IRA)
  individual_retirement_account	Individual Retirement Account
  inherited_independent_retirement_advice	Inherited Independent Retirement Advice (Inherited IRA)
  junior_personal_pension_plan	Junior SIPP
  master_trust_pension	Master Trust Pension
  money_purchase_contracted	Money Purchase Contracted
  national_employers_savings_trust	National Employers Savings Trust (NEST)
  offshore_pension	Offshore Pension
  pension_fund_withdrawal	Pension Fund Withdrawal
  personal_pension_plan	Personal Pension Plan
  phased_retirement	Phased Retirement
  pia_non_protected_rights	PIA (Non Protected Rights)
  qnups	QNUPs
  qnups_wrapper	QNUPs Wrapper
  qrops	QROPs
  qrops_wrapper	QROPs Wrapper
  rnups_wrapper	RNUPs Wrapper
  roth_inherited_independent_retirement_advice	Roth Inherited Independent Retirement Advice (Roth IRA)
  s226_rac	S226 RAC
  s32_buyout_bond	S32 Buyout Bond
  sipp	SIPP
  sipp_wrapper	SIPP Wrapper
  ssas	Ssas
  stakeholder_individual	Stakeholder Individual
  third_way_pensions	Third Way Pensions
  trustee_investment_plan	Trustee Investment Plan
  unsecured_pension	Unsecured Pension
  uurbs	UURBs
  workplace_pension_scheme	Workplace Pension Scheme
  pension_unknown	Unknown
  annuity_non_pension	Annuity (Non Pension)
  compulsory_purchase_life_annuity	Compulsory Purchase Life Annuity
  deferred_annuity	Deferred Annuity
  defined_benefit_trustee_buy_in	Defined Benefit Trustee Buy In
  enhanced_pension_annuity	Enhanced Pension Annuity
  fixed_term_annuity	Fixed Term Annuity
  group_final_salary	Group Final Salary
  hancock_annuity	Hancock Annuity
  impaired_life_annuity	Impaired Life Annuity
  ivpp	IVPP
  lifetime_annuity	Lifetime Annuity
  pension_annuity	Pension Annuity
  pension_annuity_conventional	Pension Annuity (Conventional)
  pension_annuity_flexible	Pension Annuity (Flexible)
  pension_annuity_impaired_life	Pension Annuity (Impaired Life)
  pension_annuity_temporary	Pension Annuity (Temporary)
  pension_annuity_unit_linked	Pension Annuity (Unit Linked)
  pension_annuity_with_profits	Pension Annuity (With Profits)
  purchased_life_annuity	Purchased Life Annuity
  scheme_pension	Scheme Pension
  annuity_unknown	Unknown
  dental_insurance	Dental Insurance
  general_insurance_building	General Insurance (Building)
  general_insurance_building_contents	General Insurance (Building & Contents)
  general_insurance_commercial_combined	General Insurance (Commercial Combined)
  general_insurance_commercial_motor	General Insurance (Commercial Motor)
  general_insurance_contents	General Insurance (Contents)
  general_insurance_directors_and_officers	General Insurance (Directors And Officers)
  general_insurance_extended_warranty	General Insurance (Extended Warranty)
  general_insurance_legal_expenses	General Insurance (Legal Expenses)
  general_insurance_let_property	General Insurance (Let Property)
  general_insurance_liability	General Insurance (Liability)
  general_insurance_other	General Insurance Other
  general_insurance_payment_protection	General Insurance (Payment Protection)
  general_insurance_private_motor	General Insurance (Private Motor)
  general_insurance_professional_indemnity	General Insurance (Professional Indemnity)
  general_insurance_travel	General Insurance (Travel)
  group_travel_insurance	Group Travel Insurance
  healthcare_cash_plan	Healthcare Cash Plan
  international_private_medical_insurance	International Private Medical Insurance (IPMI)
  locum_insurance	Locum Insurance
  long_term_care	Long Term Care
  long_term_care_immediate	Long Term Care (Immediate)
  long_term_care_pre_funded	Long Term Care (Pre-Funded)
  private_medical_insurance	Private Medical Insurance
  general_insurance_unknown	Unknown
  cpb	CPB
  employee_assistance_scheme	Employee Assistance Scheme
  flexible_benefits	Flexible Benefits
  group_accident_and_sickness	Group Accident And Sickness
  group_critical_illness	Group Critical Illness
  group_death_in_service	Group Death In Service
  group_dental_insurance	Group Dental Insurance
  group_healthcare_cash_plan	Group Healthcare Cash Plan
  group_income_protection	Group Income Protection
  group_income_protection_key_person	Group Income Protection (Key Person)
  group_key_person_assurance	Group Key Person Assurance
  group_life	Group Life
  group_life_excepted	Group Life (Excepted)
  group_life_registered	Group Life (Registered)
  group_partnership_protection	Group Partnership Protection
  group_personal_accident	Group Personal Accident
  group_pmi	Group PMI
  group_relevant_life	Group Relevant Life
  group_term	Group Term
  group_protection_unknown	Unknown
  equity_release	Equity Release
  mortgage	Mortgage
  mortgage_bridging_loan	Bridging Loan Mortgage
  mortgage_business_buy_to_let	Mortgage Business Buy To Let
  mortgage_buy_to_let	Buy To Let Mortgage
  mortgage_consumer_buy_to_let	Consumer Buy To Let Mortgage
  mortgage_council_tenant_to_buy	Council/Tenant To Buy Mortgage
  mortgage_foreign_currency	Foreign Currency Mortgage
  mortgage_full_status	Mortgage Full Status
  mortgage_further_advance	Further Advance Mortgage
  mortgage_government_home_ownership_scheme	Government Home Ownership Scheme Mortgage
  mortgage_home_purchase_plan	Home Purchase Plan Mortgage
  mortgage_investment_property_islamic	Investment Property Islamic Mortgage
  mortgage_let_to_buy	Let To Buy Mortgage
  mortgage_lifetime	Mortgage Lifetime
  mortgage_non_status	Mortgage Non Status
  mortgage_primary_residence_islamic	Primary Residence Islamic Mortgage
  mortgage_product_transfer	Product Transfer Mortgage
  mortgage_remortgage	Remortgage Mortgage
  mortgage_right_to_buy	Right To Buy Mortgage
  mortgage_second_charge	Second Charge Mortgage
  mortgage_second_home	Second Home Mortgage
  mortgage_self_build	Self-Build Mortgage
  mortgage_self_cert	Mortgage Self Cert
  mortgage_shared_ownership	Shared Ownership Mortgage
  mortgage_standard_residential	Standard Residential Mortgage
  mortgage_non_regulated_bridging_loan	Non-Regulated Bridging Loan Mortgage
  mortgage_non_regulated_buy_to_let	Non-Regulated Buy To Let Mortgage
  mortgage_non_regulated_commercial	Non-Regulated Commercial Mortgage
  mortgage_non_regulated_further_advance	Non-Regulated Further Advance Mortgage
  mortgage_non_regulated_offshore	Non-Regulated Offshore Mortgage
  mortgage_non_regulated_overseas	Non-Regulated Overseas Mortgage
  mortgage_non_regulated_product_transfer	Non-Regulated Product Transfer Mortgage
  third_party_mortgage	Third Party Mortgage
  mortgage_unknown	Unknown
  bridging_loan	Bridging Loan
  car_finance	Car Finance
  commercial_finance	Commercial Finance
  consumer_finance	Consumer Finance
  credit_card	Credit Card
  landlords	Landlords
  other_long_term_loan	Other Long Term Loan
  overdraft	Overdraft
  partner_loan	Partner Loan
  peer_to_peer_loan	Peer To Peer Loan
  personal_loan	Personal Loan
  personal_loan_secured	Personal Loan (Secured)
  personal_loan_unsecured	Personal Loan (Unsecured)
  public_liability	Public Liability
  student_loan	Student Loan
  will_trust_loan	Will Trust Loan
  loan_credit_unknown	Unknown
  boat	Boat
  collectible_art_other	Collectible/Art/Other
  land	Land
  motor_vehicle	Motor Vehicle
  other	Other
  own_business	Own Business
  property	Property
  property_btl	Property (Btl)
  property_investment	Property (Investment)
  property_rental	Property (Rental)
  property_other	Property (Other)
  property_overseas	Property (Overseas)
  fixed_asset_unknown	Unknown

  Values are cash_account, cash_deposit, isa_mini_cash, isa_tessa_only, lifetime_isa_cash, national_savings, national_savings_child_bonus_bond, national_savings_fixed_interest_certificate, national_savings_guaranteed_equity_bond, national_savings_income_bond, national_savings_index_linked_certificate, national_savings_national_savings_certificate, national_savings_premium_bonds, cash_account_unknown, aim_investment_tax_service, bes, business_premises_renovation_allowance, child_trust_fund, collective_investment_account, commercial_property_purchase_scheme, debenture, discretionary_managed_service, employee_benefit_trust, enterprise_investment_scheme_non_regulated, enterprise_investment_scheme_regulated, enterprise_investment_zone_trust, enterprise_zone_syndicate, equity_holdings, exchange_traded_fund, exempt_property_unit_trust, film_partnership, geared_investments, general_investment_account, hedge_fund, investment_bond, investment_tax_service, investment_trust, isa_aim, isa_cash, isa_help_to_buy, isa_maxi, isa_maxi_mini_transfer, isa_mini_equity, isa_nisa, isa_stocks_and_shares, junior_isa_cash, junior_isa_nisa, junior_isa_stocks_and_shares, lifetime_isa_stocks_and_shares, maximum_investment_plan_investment, non_discretionary_managed_service, oeic_unit_trust, offshore_bond, offshore_deposit, offshore_oeic_fund, offshore_savings_plan, onshore_bond, personal_equity_plan, property_holdings, property_partnership, property_syndicate, residential_property_development, savings_account, seed_enterprise_investment_scheme_non_regulated, seed_enterprise_investment_scheme_regulated, share_incentive_plan, share_save_scheme, sicav, structured_plan, structured_plan_cash_isa, structured_plan_deposit, structured_plan_medium_term_note, structured_plan_stocks_shares_isa, tessa, trust, unit_trust, unregulated_collective_investments, venture_capital_trust_non_regulated, venture_capital_trust_regulated, wrap, investment_unknown, accident_and_sickness_insurance, accident_sickness_and_unemployment_insurance, accidental_death_insurance, business_loan_protection, capital_redemption_policy, death_in_service, endowment, flexible_plan, general_insurance_income_protection, gift_inter_vivos, health_assessment, income_protection, income_protection_executive, income_protection_key_person, life_settlement_fund, maximum_investment_plan, multi_benefit_protection, pension_contribution_insurance, pension_term_assurance, pre_paid_funeral_plan, redundancy_insurance, relevant_life_policy, renewable_convertible_term, term_protection, term_protection_convertible, term_protection_critical_illness, term_protection_decreasing_term, term_protection_decreasing_term_ci, term_protection_decreasing_term_life_ci, term_protection_directors_share_protection, term_protection_family_income_protection, term_protection_family_income_protection_ci, term_protection_family_income_protection_life_ci, term_protection_increasing_term, term_protection_key_person_assurance, term_protection_level, term_protection_level_ci, term_protection_level_life_ci, term_protection_mortgage_protection, term_protection_partnership_protection, term_protection_renewable, unemployment_insurance, whole_of_life, whole_of_life_non_investment, will, protection_policy_unknown, alternatively_secured_pension_plan, appropriate_personal_pension, avc, cimp, cimp_comp, comp, deferred_sipp, defined_benefit_pension, dependants_pension, efrbs, equivalent_pension_benefits, executive_pension_plan, family_sipp, final_salary_scheme, fsavc, furbs, group_cimp, group_comp, group_dependants_pension, group_offshore_pension_scheme, group_personal_pension, group_s32_buyout_bond, group_sipp, group_stakeholder_pension, income_drawdown_beneficiary, income_drawdown_capped, income_drawdown_flexi_access, income_drawdown_flexible, independent_retirement_advice, individual_retirement_account, inherited_independent_retirement_advice, junior_personal_pension_plan, master_trust_pension, money_purchase_contracted, national_employers_savings_trust, offshore_pension, pension_fund_withdrawal, personal_pension_plan, phased_retirement, pia_non_protected_rights, qnups, qnups_wrapper, qrops, qrops_wrapper, rnups_wrapper, roth_inherited_independent_retirement_advice, s226_rac, s32_buyout_bond, sipp, sipp_wrapper, ssas, stakeholder_individual, third_way_pensions, trustee_investment_plan, unsecured_pension, uurbs, workplace_pension_scheme, pension_unknown, annuity_non_pension, compulsory_purchase_life_annuity, deferred_annuity, defined_benefit_trustee_buy_in, enhanced_pension_annuity, fixed_term_annuity, group_final_salary, hancock_annuity, impaired_life_annuity, ivpp, lifetime_annuity, pension_annuity, pension_annuity_conventional, pension_annuity_flexible, pension_annuity_impaired_life, pension_annuity_temporary, pension_annuity_unit_linked, pension_annuity_with_profits, purchased_life_annuity, scheme_pension, annuity_unknown, dental_insurance, general_insurance_building, general_insurance_building_contents, general_insurance_commercial_combined, general_insurance_commercial_motor, general_insurance_contents, general_insurance_directors_and_officers, general_insurance_extended_warranty, general_insurance_legal_expenses, general_insurance_let_property, general_insurance_liability, general_insurance_other, general_insurance_payment_protection, general_insurance_private_motor, general_insurance_professional_indemnity, general_insurance_travel, group_travel_insurance, healthcare_cash_plan, international_private_medical_insurance, locum_insurance, long_term_care, long_term_care_immediate, long_term_care_pre_funded, private_medical_insurance, general_insurance_unknown, cpb, employee_assistance_scheme, flexible_benefits, group_accident_and_sickness, group_critical_illness, group_death_in_service, group_dental_insurance, group_healthcare_cash_plan, group_income_protection, group_income_protection_key_person, group_key_person_assurance, group_life, group_life_excepted, group_life_registered, group_partnership_protection, group_personal_accident, group_pmi, group_relevant_life, group_term, group_protection_unknown, equity_release, mortgage, mortgage_bridging_loan, mortgage_business_buy_to_let, mortgage_buy_to_let, mortgage_consumer_buy_to_let, mortgage_council_tenant_to_buy, mortgage_foreign_currency, mortgage_full_status, mortgage_further_advance, mortgage_government_home_ownership_scheme, mortgage_home_purchase_plan, mortgage_investment_property_islamic, mortgage_let_to_buy, mortgage_lifetime, mortgage_non_status, mortgage_primary_residence_islamic, mortgage_product_transfer, mortgage_remortgage, mortgage_right_to_buy, mortgage_second_charge, mortgage_second_home, mortgage_self_build, mortgage_self_cert, mortgage_shared_ownership, mortgage_standard_residential, mortgage_non_regulated_bridging_loan, mortgage_non_regulated_buy_to_let, mortgage_non_regulated_commercial, mortgage_non_regulated_further_advance, mortgage_non_regulated_offshore, mortgage_non_regulated_overseas, mortgage_non_regulated_product_transfer, third_party_mortgage, mortgage_unknown, bridging_loan, car_finance, commercial_finance, consumer_finance, credit_card, landlords, other_long_term_loan, overdraft, partner_loan, peer_to_peer_loan, personal_loan, personal_loan_secured, personal_loan_unsecured, public_liability, student_loan, will_trust_loan, loan_credit_unknown, boat, collectible_art_other, land, motor_vehicle, other, own_business, property, property_btl, property_investment, property_rental, property_other, property_overseas, or fixed_asset_unknown.

• external_reference object
  Hide external_reference attributes Show external_reference attributes object

  • third_party string Required

    The third party that the reference is from.

    Value	Description
    adviser_office	Adviser Office
    aj_bell	Aj Bell
    be_iq_organisation	Be Iq Organisation
    cash_calc	Cash Calc
    conquest	Conquest
    filehaven	Filehaven
    finio	Finio
    fundment	Fundment
    intelliflo_office	Intelliflo Office
    nucleus	Nucleus
    octopus_money	Octopus Money
    p1	P1
    parmenion	Parmenion
    seccl	Seccl
    smartsearch	Smartsearch
    soderberg	Soderberg
    transact_remuneration	Transact Remuneration

    Values are adviser_office, aj_bell, be_iq_organisation, cash_calc, conquest, filehaven, finio, fundment, intelliflo_office, nucleus, octopus_money, p1, parmenion, seccl, smartsearch, soderberg, or transact_remuneration.

  • reference string Required

    The reference value.