Taxonomy

Retrieves a paginated list of mortgage broker types. Returns all available broker type classifications in the system, such as Credit Intermediary, Non-Tied Credit Intermediary, Promoter, Client Referer, Group/Zone, and Master. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of mortgage broker sub-types. Returns broker sub-type classifications that provide additional categorization within broker types. Sub-types are linked to their parent broker types and help further classify broker entities. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of broker classification types. Returns classification categories used to categorize mortgage brokers based on their regulatory status, operational scope, or business model. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of broker fee types. Returns the types of fees that can be charged by mortgage brokers for their services, such as commission fees, consultation fees, or processing fees. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of broker status types. Returns the available status classifications for mortgage brokers, such as Active, Inactive, Suspended, or Pending Approval. These statuses indicate the current operational state of a broker. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of broker IVA regimes. Returns the different IVA regimes applicable to mortgage brokers. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of broker retention regimes. Returns the different retention regimes applicable to mortgage brokers. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of broker extract periodicities. Returns the different extract periodicities applicable to mortgage brokers. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of countries. Returns all countries available in the system with their localized names and geographic identifiers. This endpoint is typically used for populating country selection dropdowns in forms. Results are localized based on the authenticated user's language preference.

Retrieves a specific country with its associated districts. Returns detailed information about a country along with a paginated list of its administrative districts. Supports filtering districts by partial name match for autocomplete scenarios. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of districts. Returns all administrative districts available in the system with their localized names. Districts are regional subdivisions within countries, typically used for geographic organization. Results are localized based on the authenticated user's language preference.

Retrieves a specific district with its associated counties. Returns detailed information about a district along with a paginated list of its counties (municipalities). Supports filtering counties by partial name match for autocomplete scenarios. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of counties (municipalities). Returns all counties (municipalities) available in the system with their localized names. Counties are administrative subdivisions within districts. Results are localized based on the authenticated user's language preference.

Retrieves a specific county with its associated parishes. Returns detailed information about a county along with a paginated list of its parishes (civil parishes). Supports filtering parishes by partial name match for autocomplete scenarios. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of parishes (civil parishes). Returns all parishes (civil parishes/freguesias) available in the system with their localized names. Parishes are the smallest administrative subdivision within counties. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of document types. Returns all document types used in the mortgage origination process, such as ID documents, proof of income, property deeds, bank statements, and other required documentation. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of document categories. Returns document categories used to organize and classify documents in the mortgage process. Categories help group related document types for better organization and workflow management. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of product purposes. Returns the main purposes for mortgage products, such as Home Purchase, Construction, Refinancing, or Home Improvements. These define the primary intent of the loan product. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of loan purposes. Returns specific loan purposes that provide more granular classification than product purposes. These detail the exact use of loan funds within the broader product purpose category. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of product schemes. Returns available product scheme classifications, such as conventional mortgages, government-backed programs, or special financing schemes. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of index type subcategories. Returns interest rate index subcategories, such as Variable, Fixed, or Mixed rate classifications. These subcategories determine how interest rates are calculated and adjusted over the loan term. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of variable interest rate index types. Returns index types for variable rate products, such as Euribor 3M, 6M, 12M, or other market-based indices. Can be filtered by portfolio IDs to return only indices applicable to specific portfolios. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of mixed (fixed-variable) interest rate index types. Returns index types for mixed rate products that combine fixed and variable rate periods. These products typically start with a fixed rate period and then switch to a variable rate. Can be filtered by portfolio IDs to return only indices applicable to specific portfolios. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of fixed-to-fixed interest rate period types. Returns fixed period options for products that maintain a fixed rate throughout the loan term or transition from one fixed period to another. Examples include 2-year, 5-year, or 10-year fixed periods. Can be filtered by portfolio IDs to return only periods applicable to specific portfolios. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of mixed fixed period types. Returns fixed period durations available for the initial fixed-rate portion of mixed-rate products. After the fixed period expires, the rate typically converts to a variable rate indexed to market rates. Can be filtered by portfolio IDs to return only periods applicable to specific portfolios. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of bank charge types. Returns types of charges and fees that banks may apply to mortgage products, such as origination fees, appraisal fees, processing fees, or administrative charges. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of property typologies. Returns property type classifications used in mortgage simulations and applications, such as Apartment, House, Commercial Property, Land, or Mixed-Use Property. These typologies affect valuation, loan-to-value ratios, and eligibility criteria. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of entity types. Returns entity type classifications used in mortgage proposals, such as Borrower, Co-Borrower, Guarantor, or Legal Representative. These define the role and relationship of individuals or entities in the mortgage application. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of identification document types. Returns valid identification document types accepted in mortgage applications, such as National ID Card, Passport, Driver's License, or Residence Permit. These are used for identity verification and compliance purposes. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of marital status types. Returns marital status classifications such as Single, Married, Divorced, Widowed, or in a Domestic Partnership. Marital status affects income assessment, liability evaluation, and required documentation in mortgage applications. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of matrimonial regime types. Returns matrimonial property regime classifications that define how assets and liabilities are shared between spouses, such as Community of Property, Separation of Property, or Participation in Acquisitions. This affects credit analysis and collateral evaluation. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of residence types. Returns residence type classifications such as Owner-Occupied, Rented, Living with Family, or Company-Provided Housing. This information is used for expense assessment and determining housing cost stability. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of gender types. Returns gender classifications such as Male, Female, or Other/Prefer not to say. This information is collected for demographic analysis and regulatory compliance. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of profession types. Returns profession/occupation classifications used to categorize borrowers' employment, such as Employee, Self-Employed Professional, Business Owner, Retired, or Student. Profession type affects income verification requirements and risk assessment. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of employment contract type Returns employment contract type classifications such as Permanent Contract, Fixed-Term Contract, Temporary/Seasonal, Independent Contractor, or No Contract. Contract type affects income stability assessment and required documentation for employment verification. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of employment situation types. Returns employment situation classifications such as Employed, Self-Employed, Unemployed, Retired, Student, or Homemaker. This categorizes the borrower's current employment status and affects eligibility and income assessment. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of employment department position types. Returns organizational position/department classifications within employment structures, such as Executive/Management, Technical/Professional, Administrative, or Operational roles. This information helps assess income level and employment stability. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of key borrower relations. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of proposal cancellation reasons. Returns standardized reasons for canceling mortgage proposals, such as Client Request, Failed Credit Check, Incomplete Documentation, Better Offer Found, or Property Issues. These reasons are used for tracking and analytics purposes. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of proposal rejection reasons. Returns standardized reasons for rejecting mortgage proposals by underwriters or lenders, such as Insufficient Income, High Debt-to-Income Ratio, Poor Credit History, Inadequate Collateral, or Policy Non-Compliance. Used for decision tracking and applicant feedback. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of simulation rejection reasons. Returns standardized reasons for rejecting mortgage simulations during preliminary analysis, such as Exceeds Maximum LTV, Insufficient Affordability, Outside Age Limits, or Product Not Available. Used for pre-qualification filtering and user guidance. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of workflow phases. Returns the major phases in the mortgage origination workflow, such as Simulation, Pre-Analysis, Documentation, Underwriting, Approval, and Closing. These phases represent high-level stages in the loan processing lifecycle. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of workflow states for mortgage simulations. Returns detailed workflow states specific to the simulation process, such as Draft, Submitted, Under Review, Approved, Rejected, or Expired. These states track the progression and current status of mortgage simulations through the workflow. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of workflow states for mortgage proposals. Returns detailed workflow states specific to the proposal process, such as Draft, Pending Documentation, In Underwriting, Conditionally Approved, Approved, Rejected, or Withdrawn. These states track the progression and current status of formal mortgage proposals through the workflow. Results are localized based on the authenticated user's language preference.

Retrieves a paginated list of notification types.