/api/FactFinders

Description: The operation creates a completely empty draft Fact Finder. Requirements: A householdId and list of modules must be provided. Purpose: Stages a Fact Finder for population.

/api/AccountTypes

Description: This operation retrieves all Account Types for the specified country. Purpose: Provides access to the Account Types including id and type description.

• country (query, required) — The country used to filter Account Types

/api/AccountTypes/{id}

Description: This operation retrieves all Account Types for the specified id. Purpose: Provides access to the Account Types including id and type description.

• id (path, required) — The ID of Account Type used to retreive the Account Type information

/api/Accounts

Description: This operation retrieves all Accounts for the specified Fact Finder ID and/or external source ID. Purpose: Provides access to the Account information including description and market value.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Accounts
• externalSourceId (query) — The external ID used to filter Accounts

/api/Accounts

Description: The operation creates an Account. Purpose: Allows for creation of Accounts on a Fact Finder.

/api/Accounts/{accountId}/Holdings

Retrieves all holdings in the specified Account.

• accountId (path, required) — The ID of the Account used to retrieve the Account Holding data

/api/Accounts/{accountId}/Holdings

Creates a holding and adds it to an existing Account.

• accountId (path, required) — The existing Account ID used to identify which Account to add the holding to

/api/Accounts/{accountId}/Holdings

Updates all holdings associated with an account

• accountId (path, required) — The account with the holding to be updated

/api/Accounts/{accountId}/Holdings/{id}

Description: This operation deletes a single Account Holding for the specified Account Holding ID and Account ID. Purpose: Provides the ability to remove individual holdings from a specified Account.

• accountId (path, required) — The ID of the Account used to retrieve the Account data that the specified holding belongs to.
• id (path, required) — The ID of the Account Holding used to delete the Account Holding

/api/Accounts/{accountId}/Holdings/{id}

Description: This operation retrieves a single Account Holding for the specified Account Holding ID and Account ID. Purpose: Provides access to the Account Holding information including description and market value.

• accountId (path, required) — The ID of the Account used to retrieve the Account Holding data
• id (path, required) — The ID of the Account Holding used to retrieve the Account Holding data

/api/Accounts/{accountId}/Holdings/{id}

Updates a holding associated with an account

• accountId (path, required) — The account with the holding to be updated
• id (path, required) — The id of the holding to update

/api/Accounts/{accountId}/SavingsStrategies

Deletes all savings strategies tied to an account

• accountId (path, required) — Id of the account that holds the savings strategies

/api/Accounts/{accountId}/SavingsStrategies

Get all of the savings strategies for a specific account

• accountId (path, required) — The id of the account to retrieve the savings strategies from

/api/Accounts/{accountId}/SavingsStrategies

Creates a savings strategy on a specific account

• accountId (path, required) — Id of the account to create a savings strategy for

/api/Accounts/{accountId}/SavingsStrategies/{id}

Deletes a specific savings strategy

• accountId (path, required) — Id of the account that holds the savings strategy
• id (path, required) — Id of the savings strategy to be deleted

/api/Accounts/{accountId}/SavingsStrategies/{id}

Get a specific savings strategy for an account

• accountId (path, required) — The id of the account to retrieve the savings strategies from
• id (path, required) — The id of the savings strategy to get

/api/Accounts/{accountId}/SavingsStrategies/{id}

Updates a specific savings strategy

• accountId (path, required) — Id of the account that holds the savings strategy
• id (path, required) — Id of the savings strategy to update

/api/Accounts/{id}

Description: The operation removes an Account tied to a Fact Finder. Purpose: Allows for removal of an Account from a Fact Finder.

• id (path, required) — The Account ID used to identify which Account to remove

/api/Accounts/{id}

Description: This operation retrieves a single Account for the specified Account ID. Purpose: Provides access to the Account information including description and market value.

• id (path, required) — The ID of the Account used to retrieve the Account data

/api/Accounts/{id}

Description: The operation updates an Account, deletes associated saving strategies if the account type changes. Purpose: Allows for complete replacement of an Account on a Fact Finder.

• id (path, required) — The existing Account ID used to identify which Account to update

/api/Clients

Description: This operation submits the Fact Finder data to an external system. Purpose: Allows Fact Finder data to be persisted in another system for that system's consumption and use.

/api/CriticalIllnessInsurancePolicies

Description: This operation retrieves all Critical Illness Insurance Policies for the specified Fact Finder ID. Purpose: Provides access to the Critical Illness Insurance Policies including description and policy type.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Critical Illness Insurance Policies

/api/CriticalIllnessInsurancePolicies

Description: The operation creates a Critical Illness Insurance Policy. Purpose: Allows for creation of Critical Illness Insurance Policies on a Fact Finder.

/api/CriticalIllnessInsurancePolicies/{id}

Description: The operation removes a Critical Illness Insurance Policy tied to a Fact Finder. Purpose: Allows for removal of a Critical Illness Insurance Policy from a Fact Finder.

• id (path, required) — The Critical Illness Insurance Policy ID used to identify which Critical Illness Insurance Policy to remove

/api/CriticalIllnessInsurancePolicies/{id}

Description: This operation retrieves a single Critical Illness Insurance Policy for the specified Critical Illness Insurance Policy ID. Purpose: Provides access to the Critical Illness Insurance Policy including description and policy type.

• id (path, required) — The ID of the Critical Illness Insurance Policy used to retreive the Critical Illness Insurance Policy

/api/CriticalIllnessInsurancePolicies/{id}

Description: The operation updates a Critical Illness Insurance Policy. Purpose: Allows for complete replacement of a Critical Illness Insurance Policy on a Fact Finder.

• id (path, required) — The existing Critical Illness Insurance Policy ID used to identify which Critical Illness Insurance Policy to update

/api/CriticalIllnessInsurancePolicyTypes

Description: This operation retrieves all Critical Illness Insurance Policy Types for the specified country. Purpose: Provides access to the Critical Illness Insurance Policy Types including id and type description.

• country (query, required) — The country used to filter Critical Illness Insurance Policy Types

/api/CriticalIllnessInsurancePolicyTypes/{id}

Description: This operation retrieves the Critical Illness Insurance Policy Type for the specified id. Purpose: Provides access to the Critical Illness Insurance Policy Types including id and type description.

• id (path, required) — The ID of Critical Illness Insurance Policy Type used to retreive the Critical Illness Insurance Policy Type information

/api/DefinedBenefitPensions

Description: This operation retrieves all Defined Benefit Pensions for the specified Fact Finder ID. Purpose: Provides access to the Defined Benefit Pensions including description and start date.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Defined Benefit Pensions

/api/DefinedBenefitPensions

Description: The operation creates a Defined Benefit Pension. Purpose: Allows for creation of Defined Benefit Pensions on a Fact Finder.

/api/DefinedBenefitPensions/{id}

Description: The operation removes a Defined Benefit Pension tied to a Fact Finder. Purpose: Allows for removal of a Defined Benefit Pension from a Fact Finder.

• id (path, required) — The Defined Benefit Pension ID used to identify which Defined Benefit Pension to remove

/api/DefinedBenefitPensions/{id}

Description: This operation retrieves a single Defined Benefit Pension for the specified Defined Benefit Pension ID. Purpose: Provides access to the Defined Benefit Pension including description and start date.

• id (path, required) — The ID of the Defined Benefit Pension used to retreive the Defined Benefit Pension

/api/DefinedBenefitPensions/{id}

Description: The operation updates a Defined Benefit Pension. Purpose: Allows for complete replacement of a Defined Benefit Pension on a Fact Finder.

• id (path, required) — The existing Defined Benefit Pension ID used to identify which Defined Benefit Pension to update

/api/Demographics

Description: This operation retrieves all Demographic information for the specified Fact Finder ID. Purpose: Provides access to the Demographic information including city and state.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Demographic information

/api/Demographics

Description: The operation creates Demographic information. Purpose: Allows for creation of Demographic information on a Fact Finder.

/api/EducationGoals

Description: The operation creates an Education Goal. Purpose: Allows for creation of Education Goals on a Fact Finder.

/api/Demographics/{demographicId}/Dependents

Description: This operation retrieves all Dependents for the specified Demographic information ID. Purpose: Provides access to the Dependents including first and last name.

• demographicId (path, required) — The ID of the Demographic information used to retrieve Dependents

/api/Demographics/{demographicId}/Dependents

Description: The operation creates a Dependent. Purpose: Allows for creation of Dependents on a Fact Finder.

• demographicId (path, required) — The ID of the Demographic information to add the Dependent to

/api/Demographics/{demographicId}/Dependents/{id}

Description: The operation removes a Dependent tied to a Fact Finder. Purpose: Allows for removal of a Dependent from a Fact Finder.

• demographicId (path, required) — The ID of the Demographic information used to identify which Dependent to remove
• id (path, required) — The Dependent ID used to identify which Dependent to remove

/api/Demographics/{demographicId}/Dependents/{id}

Description: This operation retrieves a single Dependent for the specified Dependent ID. Purpose: Provides access to the Dependent including first and last name.

• demographicId (path, required) — The ID of the Demographic information used to retrieve Dependents
• id (path, required) — The ID of the Dependent used to retreive the Dependent

/api/Demographics/{demographicId}/Dependents/{id}

Description: The operation updates a Dependent. Purpose: Allows for complete replacement of a Dependent on a Fact Finder.

• demographicId (path, required) — The ID of the Demographic information used to identify which Dependent to update
• id (path, required) — The existing Dependent ID used to identify which Dependent to update

/api/Demographics/{id}

Description: This operation retrieves Demographic information for the specified Demographic information ID. Purpose: Provides access to the Demographic information including city and state.

• id (path, required) — The ID of the Demographic information used to retreive the Demographic information

/api/Demographics/{id}

Description: The operation updates Demographic information. Purpose: Allows for complete replacement of Demographic information on a Fact Finder.

• id (path, required) — The existing Demographic information ID used to identify which Demographic information to update

/api/DisabilityInsurancePolicies

Description: This operation retrieves all Disability Insurance Policies for the specified Fact Finder ID. Purpose: Provides access to the Disability Insurance Policies including description and policy type.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Disability Insurance Policies

/api/DisabilityInsurancePolicies

Description: The operation creates a Disability Insurance Policy. Purpose: Allows for creation of Disability Insurance Policies on a Fact Finder.

/api/DisabilityInsurancePolicies/{id}

Description: The operation removes a Disability Insurance Policy tied to a Fact Finder. Purpose: Allows for removal of a Disability Insurance Policy from a Fact Finder.

• id (path, required) — The Disability Insurance Policy ID used to identify which Disability Insurance Policy to remove

/api/DisabilityInsurancePolicies/{id}

Description: This operation retrieves a single Disability Insurance Policy for the specified Disability Insurance Policy ID. Purpose: Provides access to the Disability Insurance Policy including description and policy type.

• id (path, required) — The ID of the Disability Insurance Policy used to retreive the Disability Insurance Policy

/api/DisabilityInsurancePolicies/{id}

Description: The operation updates a Disability Insurance Policy. Purpose: Allows for complete replacement of a Disability Insurance Policy on a Fact Finder.

• id (path, required) — The existing Disability Insurance Policy ID used to identify which Disability Insurance Policy to update

/api/DisabilityInsurancePolicyTypes

Description: This operation retrieves all Disability Insurance Policy Types for the specified country. Purpose: Provides access to the Disability Insurance Policy Types including id and type description.

• country (query, required) — The country used to filter Disability Insurance Policy Types

/api/DisabilityInsurancePolicyTypes/{id}

Description: This operation retrieves all Disability Insurance Policy Types for the specified id. Purpose: Provides access to the Disability Insurance Policy Types including id and type description.

• id (path, required) — The ID of Disability Insurance Policy Type used to retreive the Disability Insurance Policy Type information

/api/EducationGoals

Description: This operation retrieves all Education Goals for the specified Fact Finder ID. Purpose: Provides access to the Education Goals including description and projected cost.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Education Goals

/api/EducationGoals/{educationGoalId}/Expenses

Description: This operation retrieves all Education Goal Expenses for the specified Education Goal ID. Purpose: Provides access to the Education Goal Expenses including description and annual cost.

• educationGoalId (path, required) — The ID of the Education Goal used to retrieve Education Goal Expenses

/api/EducationGoals/{educationGoalId}/Expenses

Description: The operation creates an Education Goal Expense. Purpose: Allows for creation of Education Goal Expenses on a Fact Finder.

• educationGoalId (path, required) — The Education Goal ID used to locate the Goal to add the expense to

/api/EducationGoals/{educationGoalId}/Expenses/{id}

Description: The operation removes an Education Goal Expense tied to a Fact Finder. Purpose: Allows for removal of an Education Goal Expense from a Fact Finder.

• educationGoalId (path, required) — The Education Goal ID used to locate the Goal to delete the Expense under
• id (path, required) — The Education Goal Expense ID used to identify which Education Goal Expense to remove

/api/EducationGoals/{educationGoalId}/Expenses/{id}

Description: This operation retrieves a single Education Goal Expense for the specified Education Goal Expense ID. Purpose: Provides access to the Education Goal Expense including description and annual cost.

• educationGoalId (path, required) — The ID of the Education Goal used to retrieve Education Goal Expenses
• id (path, required) — The ID of the Education Goal Expense used to retreive the Education Goal Expense

/api/EducationGoals/{educationGoalId}/Expenses/{id}

Description: The operation updates an Education Goal Expense. Purpose: Allows for complete replacement of an Education Goal Expense on a Fact Finder.

• educationGoalId (path, required) — The Education Goal ID used to locate the Goal to update the Expense under
• id (path, required) — The existing Education Goal Expense ID used to identify which Education Goal Expense to update

/api/EducationGoals/{id}

Description: The operation removes an Education Goal tied to a Fact Finder. Purpose: Allows for removal of an Education Goal from a Fact Finder.

• id (path, required) — The Education Goal ID used to identify which Education Goal to remove

/api/EducationGoals/{id}

Description: This operation retrieves a single Education Goal for the specified Education Goal ID. Purpose: Provides access to the Education Goal including description and projected cost.

• id (path, required) — The ID of the Education Goal used to retreive the Education Goal

/api/EducationGoals/{id}

Description: The operation creates an Education Goal Expense. Purpose: Allows for creation of Education Goal Expenses on a Fact Finder.

• id (path, required) — The Education Goal ID used to locate the Goal to add the Expense to

/api/ExpenseTypes

Description: This operation retrieves all Expense Types for the specified country. Purpose: Provides access to the Expense Types including id and type description.

• country (query, required) — The country used to filter Expense Types

/api/ExpenseTypes/{id}

Description: This operation retrieves all Expense Types for the specified country. Purpose: Provides access to the Expense Types including id and type description.

• id (path, required) — The ID of Expense Type used to retreive the Expense Type information

/api/Expenses

Description: This operation retrieves all Expenses for the specified Fact Finder ID. Purpose: Provides access to the Expenses including description and Expense type.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Expenses

/api/Expenses

Description: The operation creates an Expense. Purpose: Allows for creation of Expenses on a Fact Finder.

/api/Expenses/{id}

Description: The operation removes an Expense tied to a Fact Finder. Purpose: Allows for removal of an Expense from a Fact Finder.

• id (path, required) — The Expense ID used to identify which Expense to remove

/api/Expenses/{id}

Description: This operation retrieves a single Expense for the specified Expense ID. Purpose: Provides access to the Expense including description and Expense type.

• id (path, required) — The ID of the Expense used to retreive the Expense

/api/Expenses/{id}

Description: The operation updates an Expense. Purpose: Allows for complete replacement of an Expense on a Fact Finder. Note: Expense type cannot be changed for expenses prepopulated from NaviPlan.

• id (path, required) — The existing Expense ID used to identify which Expense to update

/api/FactFinders

Description: This operation retrieves all Fact Finders for the specified householdId, or if null, all households associated with the user. Purpose: Provides access to the Fact Finder including status.

• householdId (query) — The ID of the household used to retrieve the fact finders. If not set, uses all households associated with the user

/api/FactFinders/Populate

Description: The operation creates a new Populated Fact Finder. Requirements: A householdId and list of modules must be provided. Purpose: Creation of a Fact Finder.

/api/FactFinders/{factFinderId}/Modules

Description: This operation retrieves all Fact Finder Modules for the specified Fact Finder ID. Purpose: Provides access to the Fact Finder Modules including description and policy type.

• factFinderId (path, required) — The ID of the Fact Finder used to retrieve Fact Finder Modules

/api/FactFinders/{factFinderId}/Modules/{id}

Description: This operation retrieves a single Fact Finder Module for the specified Fact Finder Module ID. Purpose: Provides access to the Fact Finder Module including description and policy type.

• factFinderId (path, required) — The ID of the Fact Finder used to retrieve Fact Finder Module
• id (path, required) — The ID of the Fact Finder Module used to retreive the Fact Finder Module

/api/FactFinders/{factFinderId}/Modules/{id}

Description: The operation updates a Fact Finder Module. Purpose: Allows for complete replacement of a Fact Finder Module on a Fact Finder.

• factFinderId (path, required) — The ID of the Fact Finder used to identify the Fact Finder Module to update
• id (path, required) — The existing Fact Finder Module ID used to identify which Fact Finder Module to update

/api/FactFinders/{factFinderId}/Snapshots

Description: The operation retrieves Snapshots of a Fact Finder. Purpose: Allows for advisors to view all Snapshots taken of a Fact Finder.

• factFinderId (path, required) — The ID of the Fact Finder to retrieve Snapshots for

/api/FactFinders/{factFinderId}/Snapshots

Description: The operation creates a Snapshot of a Fact Finder. Purpose: Allows for advisors to compare the current fact finder to a snapshot prior to acceptance.

• factFinderId (path, required) — The ID of the Fact Finder used to create the Fact Finder Snapshot

/api/FactFinders/{id}

Description: This operation deletes a single Fact Finder for the specified Fact Finder ID. Purpose: Deletes the fact finder.

• id (path, required) — The ID of the Fact Finder to be deleted

/api/FactFinders/{id}

Description: This operation retrieves a single Fact Finder for the specified Fact Finder ID. Purpose: Provides access to the Fact Finder including status.

• id (path, required) — The ID of the Fact Finder used to retrieve the Fact Finder

/api/FactFinders/{id}

Description: The operation updates a Fact Finder. Purpose: Allows for the updating of a Fact Finder.

• id (path, required) — The existing Fact Finder ID used to identify which Fact Finder to update

/api/FactFinders/{id}/Populate

Description: The operation populates a fact finder. Purpose: Allows for the population of a Fact Finder based on a NaviPlan plan or client. This operation cannot be performed on a Fact Finder more than once.

• id (path, required) — The existing Fact Finder ID used to identify which Fact Finder to populate.

/api/FilingStatusTypes

Description: This operation retrieves all Filing Status Types for the specified country. Purpose: Provides access to the Filing Status Types including id and type description.

• country (query, required) — The country used to filter Filing Status Types

/api/FilingStatusTypes/{id}

Description: This operation retrieves all Filing Status Type for the specified id. Purpose: Provides access to the Filing Status Types including id and type description.

• id (path, required) — The ID of Filing Status Type used to retreive the Filing Status Type information

/api/FrequencyTypes

Description: This operation retrieves all Frequency Types for the specified country and entity. Purpose: Provides access to the Frequency Types including id and type description.

• entity (query, required) — The entity used to filter Frequency Types
• country (query, required) — The country used to filter Frequency Types

/api/FrequencyTypes/{id}

Description: This operation retrieves the Frequency Type for the specified id. Purpose: Provides access to the Frequency Types including id and type description.

• id (path, required) — The ID of Frequency Type used to retreive the Frequency Type information

/api/IncomeTypes

Description: This operation retrieves all Income Types for the specified country. Purpose: Provides access to the Income Types including id and type description.

• country (query, required) — The country used to filter Income Types

/api/IncomeTypes/{id}

Description: This operation retrieves the Income Type for the specified id. Purpose: Provides access to the Income Types including id and type description.

• id (path, required) — The ID of Income Type used to retreive the Income Type information

/api/Incomes

Description: This operation retrieves all Incomes for the specified Fact Finder ID. Purpose: Provides access to the Incomes including annual amount and start date.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Incomes

/api/Incomes

Description: The operation creates an Income. Purpose: Allows for creation of Incomes on a Fact Finder.

/api/Incomes/{id}

Description: The operation removes an Income tied to a Fact Finder. Purpose: Allows for removal of an Income from a Fact Finder.

• id (path, required) — The Income ID used to identify which Income to remove

/api/Incomes/{id}

Description: This operation retrieves a single Income for the specified Income ID. Purpose: Provides access to the Income including annual amount and start date.

• id (path, required) — The ID of the Income used to retreive the Income

/api/Incomes/{id}

Description: The operation updates an Income. Purpose: Allows for complete replacement of an Income on a Fact Finder.

• id (path, required) — The existing Income ID used to identify which Income to update

/api/Liabilities

Description: This operation retrieves all Liabilities for the specified Fact Finder ID. Purpose: Provides access to the Liabilities including owner and type.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Liabilities
• externalSourceId (query) — The external source ID used to filter Liabilities

/api/Liabilities

Description: The operation creates a Liability. Purpose: Allows for creation of Liabilities on a Fact Finder.

/api/Liabilities/{id}

Description: The operation removes a Liability tied to a Fact Finder. Purpose: Allows for removal of a Liability from a Fact Finder.

• id (path, required) — The Liability ID used to identify which Liability to remove

/api/Liabilities/{id}

Description: This operation retrieves a single Liability for the specified Liability ID. Purpose: Provides access to the Liability including owner and type.

• id (path, required) — The ID of the Liability used to retreive the Liability

/api/Liabilities/{id}

Description: The operation updates a Liability. Purpose: Allows for complete replacement of a Liability on a Fact Finder.

• id (path, required) — The existing Liability ID used to identify which Liability to update

/api/LiabilityTypes

Description: This operation retrieves all Liability Types for the specified country. Purpose: Provides access to the Liability Types including id and type description.

• country (query, required) — The country used to filter Liability Types

/api/LiabilityTypes/{id}

Description: This operation retrieves the Liability Type for the specified id. Purpose: Provides access to the Liability Types including id and type description.

• id (path, required) — The ID of Liability Type used to retreive the Liability Type information

/api/LifeInsurancePolicies

Description: This operation retrieves all Life Insurance Policies for the specified Fact Finder ID. Purpose: Provides access to the Life Insurance Policies including description and policy type.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Life Insurance Policies

/api/LifeInsurancePolicies

Description: The operation creates a Life Insurance Policy. Purpose: Allows for creation of Life Insurance Policies on a Fact Finder.

/api/LifeInsurancePolicies/{id}

Description: The operation removes a Life Insurance Policy tied to a Fact Finder. Purpose: Allows for removal of a Life Insurance Policy and associated subaccounts from a Fact Finder.

• id (path, required) — The Life Insurance Policy ID used to identify which Life Insurance Policy to remove

/api/LifeInsurancePolicies/{id}

Description: This operation retrieves a single Life Insurance Policy for the specified Life Insurance Policy ID. Purpose: Provides access to the Life Insurance Policy including description and policy type.

• id (path, required) — The ID of the Life Insurance Policy used to retreive the Life Insurance Policy

/api/LifeInsurancePolicies/{id}

Description: The operation updates a Life Insurance Policy, deletes associated sub-accounts if the policy type changes. Purpose: Allows for complete replacement of a Life Insurance Policy on a Fact Finder.

• id (path, required) — The existing Life Insurance Policy ID used to identify which Life Insurance Policy to update

/api/LifeInsurancePolicies/{lifeInsurancePolicyId}/Subaccounts

Description: Get all the subaccounts for an existing Life Insurance Policy. Purpose: Provides access to all the Life Insurance Policy subaccounts.

• lifeInsurancePolicyId (path, required) — The ID of the Life Insurance Policy used to retrieve the Life Insurance Policy Subaccounts.

/api/LifeInsurancePolicies/{lifeInsurancePolicyId}/Subaccounts

Description: Creates a subaccount and adds it to an existing Life Insurance Policy. Purpose: Allows for creation of subaccount on a Life Insurance Policy.

• lifeInsurancePolicyId (path, required) — The ID of the Life Insurance Policy used to create the Life Insurance Policy Subaccount.

/api/LifeInsurancePolicies/{lifeInsurancePolicyId}/Subaccounts/{id}

Description: Deletes an existing Life Insurance Policy Subaccount for an existing Life Insurance Policy. Purpose: Allows for removal of a subaccount from a Life Insurance Policy.

• lifeInsurancePolicyId (path, required) — The ID of the Life Insurance Policy used to delete the Life Insurance Policy Subaccount.
• id (path, required) — The ID of the Life Insurance Policy Subaccount.

/api/LifeInsurancePolicies/{lifeInsurancePolicyId}/Subaccounts/{id}

Description: Get a specific subaccount for an existing Life Insurance Policy. Purpose: Provides access to the Life Insurance Policy subaccount.

• lifeInsurancePolicyId (path, required) — The ID of the Life Insurance Policy used to retrieve the Life Insurance Policy Subaccount.
• id (path, required) — The ID of the Life Insurance Policy Subaccount.

/api/LifeInsurancePolicies/{lifeInsurancePolicyId}/Subaccounts/{id}

Description: Updates an existing Life Insurance Policy Subaccount for an existing Life Insurance Policy. Purpose: Allows for complete replacement of a subaccount on a Life Insurance Policy.

• lifeInsurancePolicyId (path, required) — The ID of the Life Insurance Policy used to update the Life Insurance Policy Subaccount.
• id (path, required) — The ID of the Life Insurance Policy Subaccount.

/api/LifeInsurancePolicyTypes

Description: This operation retrieves all Life Insurance Policy Types for the specified country. Purpose: Provides access to the Life Insurance Policy Types including id and type description.

• country (query, required) — The country used to filter Life Insurance Policy Types

/api/LifeInsurancePolicyTypes/{id}

Description: This operation retrieves the Life Insurance Policy Type for the specified id. Purpose: Provides access to the Life Insurance Policy Types including id and type description.

• id (path, required) — The ID of Life Insurance Policy Type used to retreive the Life Insurance Policy Type information

/api/LifestyleAssetTypes

Description: This operation retrieves all Lifestyle Asset Types for the specified country. Purpose: Provides access to the Lifestyle Asset Types including id and type description.

• country (query, required) — The country used to filter Lifestyle Asset Types

/api/LifestyleAssetTypes/{id}

Description: This operation retrieves the Lifestyle Asset Type for the specified id. Purpose: Provides access to the Lifestyle Asset Types including id and type description.

• id (path, required) — The ID of Lifestyle Asset Type used to retreive the Lifestyle Asset Type information

/api/LifestyleAssets

Description: This operation retrieves all Lifestyle Assets for the specified Fact Finder ID. Purpose: Provides access to the Lifestyle Assets including description and market value.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Lifestyle Assets

/api/LifestyleAssets

Description: The operation creates a Lifestyle Asset. Purpose: Allows for creation of Lifestyle Assets on a Fact Finder.

/api/LifestyleAssets/{id}

Description: The operation removes a Lifestyle Asset tied to a Fact Finder. Purpose: Allows for removal of a Lifestyle Asset from a Fact Finder.

• id (path, required) — The Lifestyle Asset ID used to identify which Lifestyle Asset to remove

/api/LifestyleAssets/{id}

Description: This operation retrieves a single Lifestyle Asset for the specified Lifestyle Asset ID. Purpose: Provides access to the Lifestyle Asset including description and market value.

• id (path, required) — The ID of the Lifestyle Asset used to retreive the Lifestyle Asset

/api/LifestyleAssets/{id}

Description: The operation updates a Lifestyle Asset. Purpose: Allows for complete replacement of a Lifestyle Asset on a Fact Finder.

• id (path, required) — The existing Lifestyle Asset ID used to identify which Lifestyle Asset to update

/api/LongTermCareInsurancePolicies

Description: This operation retrieves all Long Term Care Insurance Policies for the specified Fact Finder ID. Purpose: Provides access to the Long Term Care Insurance Policies including description and premium.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Long Term Care Insurance Policies

/api/LongTermCareInsurancePolicies

Description: The operation creates a Long Term Care Insurance Policy. Purpose: Allows for creation of Long Term Care Insurance Policies on a Fact Finder.

/api/ServiceInformation

Description: This operation retrieves information statistics for the current service. Purpose: Provides access to Service Information.

/api/LongTermCareInsurancePolicies/{id}

Description: The operation removes a Long Term Care Insurance Policy tied to a Fact Finder. Purpose: Allows for removal of a Long Term Care Insurance Policy from a Fact Finder.

• id (path, required) — The Long Term Care Insurance Policy ID used to identify which Long Term Care Insurance Policy to remove

/api/LongTermCareInsurancePolicies/{id}

Description: This operation retrieves a single Long Term Care Insurance Policy for the specified Long Term Care Insurance Policy ID. Purpose: Provides access to the Long Term Care Insurance Policy including description and premium.

• id (path, required) — The ID of the Long Term Care Insurance Policy used to retreive the Long Term Care Insurance Policy

/api/LongTermCareInsurancePolicies/{id}

Description: The operation updates a Long Term Care Insurance Policy. Purpose: Allows for complete replacement of a Long Term Care Insurance Policy on a Fact Finder.

• id (path, required) — The existing Long Term Care Insurance Policy ID used to identify which Long Term Care Insurance Policy to update

/api/MajorPurchaseGoalTypes

Description: This operation retrieves all Major Purchase Goal Types for the specified country. Purpose: Provides access to the Major Purchase Goal Types including id and type description.

• country (query, required) — The country used to filter Major Purchase Goal Types

/api/MajorPurchaseGoalTypes/{id}

Description: This operation retrieves the Major Purchase Goal Type for the specified id. Purpose: Provides access to the Major Purchase Goal Types including id and type description.

• id (path, required) — The ID of Major Purchase Goal Type used to retreive the Major Purchase Goal Type information

/api/MajorPurchaseGoals

Description: This operation retrieves all Major Purchases for the specified Fact Finder ID. Purpose: Provides access to the Major Purchases including description and amount.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Major Purchases

/api/MajorPurchaseGoals

Description: The operation creates a Major Purchase. Purpose: Allows for creation of Major Purchases on a Fact Finder.

/api/MajorPurchaseGoals/{id}

Description: The operation removes a Major Purchase tied to a Fact Finder. Purpose: Allows for removal of a Major Purchase from a Fact Finder.

• id (path, required) — The Major Purchase ID used to identify which Major Purchase to remove

/api/MajorPurchaseGoals/{id}

Description: This operation retrieves a single Major Purchase for the specified Major Purchase ID. Purpose: Provides access to the Major Purchase including description and amount.

• id (path, required) — The ID of the Major Purchase used to retreive the Major Purchase

/api/MajorPurchaseGoals/{id}

Description: The operation updates a Major Purchase. Purpose: Allows for complete replacement of a Major Purchase on a Fact Finder.

• id (path, required) — The existing Major Purchase ID used to identify which Major Purchase to update

/api/Presentation/Accounts

Description: This operation retrieves all current Accounts for the specified Fact Finder ID, as well as all of the holdings and savings strategies belonging to those accounts. Purpose: Provides access to the Accounts in a Fact Finder as well as any sub-entities belonging to them.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Accounts
• externalSourceId (query) — The external ID used to filter Accounts

/api/Presentation/Demographics/Owners

Description: This operation retrieves owner values for the fact finder based on demographics data Purpose: Provides the list of valid options for owner, student, beneficiary, etc.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve owners.

/api/Presentation/Demographics/Relationships

Description: This operation retrieves all relationship types relevant to demographics. Purpose: Provides a list of relationship types organized by whether or not they can be defined as children.

/api/Presentation/Incomes

Description: This operation retrieves all current Incomes for the specified Fact Finder ID. Purpose: Provides access to the Incomes in a Fact Finder, filtered by Incomes that are current.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Incomes

/api/Presentation/Liabilities

Description: This operation retrieves all current Liabilities for the specified Fact Finder ID. Purpose: Provides access to the Liabilities in a Fact Finder, filtered by Liabilities that are current.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Liabilities

/api/Presentation/LifeInsurancePolicies

Description: This operation retrieves all life insurance policies, including subaccounts if available, for the specified Fact Finder ID. Purpose: Provides access to the Life Insurance Policies in a Fact Finder.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Life Insurance Policies.

/api/Presentation/Pensions

Description: This operation retrieves all future Defined Benefit Pensions for the specified Fact Finder ID. Purpose: Provides access to the Pensions in a Fact Finder, filtered by Pensions that are in the future.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Pensions.

/api/RealEstateAssets

Description: This operation retrieves all Real Estate Assets for the specified Fact Finder ID. Purpose: Provides access to the Real Estate Assets including description and market value.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Real Estate Assets

/api/RealEstateAssets

Description: The operation creates a Real Estate Asset. Purpose: Allows for creation of Real Estate Assets on a Fact Finder.

/api/RealEstateAssets/{id}

Description: The operation removes a Real Estate Asset tied to a Fact Finder. Purpose: Allows for removal of a Real Estate Asset from a Fact Finder.

• id (path, required) — The Real Estate Asset ID used to identify which Real Estate Asset to remove

/api/RealEstateAssets/{id}

Description: This operation retrieves a single Real Estate Asset for the specified Real Estate Asset ID. Purpose: Provides access to the Real Estate Asset including description and market value.

• id (path, required) — The ID of the Real Estate Asset used to retreive the Real Estate Asset

/api/RealEstateAssets/{id}

Description: The operation updates a Real Estate Asset. Purpose: Allows for complete replacement of a Real Estate Asset on a Fact Finder.

• id (path, required) — The existing Real Estate Asset ID used to identify which Real Estate Asset to update

/api/RetirementGoals

Description: This operation retrieves all Retirement Goals for the specified Fact Finder ID. Purpose: Provides access to the Retirement Goals including retirement date.

• factFinderId (query, required) — The ID of the Fact Finder used to retrieve Retirement Goals

/api/RetirementGoals

Description: The operation creates a Retirement Goal. Purpose: Allows for creation of Retirement Goals on a Fact Finder.

/api/RetirementGoals/{id}

Description: The operation removes a Retirement Goal tied to a Fact Finder. Purpose: Allows for removal of a Retirement Goal from a Fact Finder.

• id (path, required) — The Retirement Goal ID used to identify which Retirement Goal to remove

/api/RetirementGoals/{id}

Description: This operation retrieves a single Retirement Goal for the specified Retirement Goal ID. Purpose: Provides access to the Retirement Goal including retirement date.

• id (path, required) — The ID of the Retirement Goal used to retreive the Retirement Goal

/api/RetirementGoals/{id}

Description: The operation updates a Retirement Goal. Purpose: Allows for complete replacement of a Retirement Goal on a Fact Finder.

• id (path, required) — The existing Retirement Goal ID used to identify which Retirement Goal to update

/api/RetirementGoals/{retirementGoalId}/Expenses

Description: This operation retrieves all Retirement Goal Expenses for the specified Retirement Goal ID. Purpose: Provides access to the Retirement Goal Expenses including description and amount.

• retirementGoalId (path, required) — The ID of the Retirement Goal used to retrieve Retirement Goal Expenses

/api/RetirementGoals/{retirementGoalId}/Expenses

Description: The operation creates a Retirement Goal Expense. Purpose: Allows for creation of Retirement Goal Expenses on a Fact Finder.

• retirementGoalId (path, required) — The ID of the Retirement Goal to add the Retirement Goal Expense to

/api/RetirementGoals/{retirementGoalId}/Expenses/{id}

Description: The operation removes a Retirement Goal Expense tied to a Fact Finder. Purpose: Allows for removal of a Retirement Goal Expense from a Fact Finder.

• retirementGoalId (path, required) — The Retirement Goal ID used to locate the Goal to delete the Retirement Goal Expense under
• id (path, required) — The Retirement Goal Expense ID used to identify which Retirement Goal Expense to remove

/api/RetirementGoals/{retirementGoalId}/Expenses/{id}

Description: This operation retrieves a single Retirement Goal Expense for the specified Retirement Goal Expense ID. Purpose: Provides access to the Retirement Goal Expense including description and amount.

• retirementGoalId (path, required) — The ID of the Retirement Goal used to retrieve the Retirement Goal Expense
• id (path, required) — The ID of the Retirement Goal Expense used to retreive the Retirement Goal Expense

/api/RetirementGoals/{retirementGoalId}/Expenses/{id}

Description: The operation updates a Retirement Goal Expense. Purpose: Allows for complete replacement of a Retirement Goal Expense on a Fact Finder.

• retirementGoalId (path, required) — The Retirement Goal ID used to locate the Goal to update the Retirement Goal Expense under
• id (path, required) — The existing Retirement Goal Expense ID used to identify which Retirement Goal Expense to update

/api/StatesProvinces

Description: This operation retrieves all States and Provinces for the specified country. Purpose: Provides access to the States and Provinces.

• country (query, required) — The country used to filter States and Provinces

/api/StatesProvinces/{id}

Description: This operation retrieves the States and Provinces for the specified id. Purpose: Provides access to the States and Provinces.

• id (path, required) — The ID of the State or Province used to retreive the State or Province information