Interhyp pre-submission-checks API

openapi: 3.0.2
info:
  title: Interhyp Submission commands pre-submission-checks API
  version: 2.0.0
  contact:
    name: Interhyp AG (Team Provider Excellence)
    email: support_submission_api@interhyp.de
  license:
    name: Interhyp AG
  description: '### This document describes the RESTful API and resources provided by Interhyp AG.<p> The RESTful API provides access to resources associated to submission process via *URI* paths, a client application will make an HTTP request using standard HTTP methods like *GET, PUT, POST and DELETE* and parse the response in *JSON* format.<p>

    ### API Audience<p> The API is intended to be consumed by clients who want to integrate Interhyp submission process in their own workflow.

    + **Bank Partners**

    ### API design Principles <p> During API design a set of principles were taken into consideration.

    + **API First**

    + **Mobile First**

    ### API client <p> As an API client you should adhere to the following robustness principle

    + **Tolerant Reader** Be tolerant with unknown fields in the payload. This is required to avoid new API versions if new fields were added, i.e. ignore new fields but do not eliminate them from payload if needed for subsequent *PUT* requests

    + Be prepared to handle HTTP status codes not explicitly specified in endpoint definitions.'
servers:
- url: https://api-test.interhyp.de/submission
  description: Test-Staging
- url: https://api.interhyp.de/submission
  description: Production
security:
- BearerAuth: []
tags:
- name: pre-submission-checks
  description: provides endpoints for pre-submission resources associated with a specific financing partner
paths:
  /pre-submission-checks:
    get:
      summary: Get a collection of pre submission checks for intent ID and loan partner ID
      description: 'This endpoint gives a possibility to retrieve collection of pre-submission checks using intent ID and loan partner ID.

        A pre-submission check provided a way of pre-scoring to allows financial advisors to get an early indication whether a submission can be created'
      operationId: getPreSubmissionChecksByIntentIdAndLoanPartnerId
      tags:
      - pre-submission-checks
      parameters:
      - $ref: '#/components/parameters/intent-id'
      - $ref: '#/components/parameters/loanpartner-id'
      - $ref: '#/components/parameters/pre-submission-check-status'
      responses:
        '200':
          description: Requested pre submission check is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreSubmissionChecks'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested submission resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /pre-submission-checks/{preSubmissionCheckId}:
    get:
      summary: Get a specific pre submission check
      description: 'This endpoint gives a possibility to retrieve information about a specific pre-submission check using it''s id.

        A pre-submission check provided a way of pre-scoring to allows financial advisors to get an early indication whether a submission can be created'
      operationId: getPreSubmissionCheckById
      tags:
      - pre-submission-checks
      parameters:
      - $ref: '#/components/parameters/pre-submission-check-id'
      responses:
        '200':
          description: Requested pre submission check is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreSubmissionCheck'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested submission resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /pre-submission-checks/{preSubmissionCheckId}/commands:
    post:
      summary: Modify an existing pre submission check.
      description: 'This endpoint gives a possibility to modify an existing pre-submission check asynchronously by creating a command to perform this operation, as a result a *command id* shall be returned.


        In order to follow up the command execution result, a call to `/v2/commands` endpoint could be made providing the *command id*

        '
      operationId: modifyPreSubmissionCheck
      tags:
      - pre-submission-checks
      parameters:
      - $ref: '#/components/parameters/pre-submission-check-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyPreSubmissionCheckCommand'
      responses:
        '201':
          description: Reference to the created resource.
          headers:
            Location:
              schema:
                type: string
                description: 'DE: Link zu einer spezifischen Ressource <br/> EN: Link to retrieve a specific resource

                  '
                example: http://some-domain/some/link/to/somewhere
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandId'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
components:
  schemas:
    EntryMarking:
      type: object
      description: 'Object to define entry markings like ''the end of the fixed interest rate'' or ''the amortization rate changed to''. The properties ''name'' and ''period'' are required and there can be additional key/value pairs for the specific markings like, ''rate: 3.5%'' for the value of the changed amortization rate if name is ''AMORTIZATION_RATE_CHANGED''.

        '
      allOf:
      - $ref: '#/components/schemas/EntryPeriod'
      required:
      - name
      properties:
        name:
          description: The name of the marking
          $ref: '#/components/schemas/MarkingName'
        rate:
          description: present if type is 'AMORTIZATION_RATE_CHANGED'
          $ref: '#/components/schemas/EuroAmount'
        amount:
          description: present if type is 'EXTRA_PAYMENT'
          $ref: '#/components/schemas/EuroAmount'
    AuxiliaryLoan:
      description: 'DE: Information zum Nachrangdarlehen. <br/>

        EN: Information about the auxiliary loan.

        '
      type: object
      required:
      - product
      allOf:
      - $ref: '#/components/schemas/BaseLoan'
      properties:
        annuityDetails:
          $ref: '#/components/schemas/AnnuityDetails'
        product:
          $ref: '#/components/schemas/AuxProductType'
    Contact:
      type: object
      properties:
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/Phone'
        email:
          type: string
          description: 'DE: E-Mail des Antragstellers <br/> EN: E-Mail of the customer

            '
          example: primary@example.com
    HouseUtilityOwnUnitGroup:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseHouseUtilityUnitGroup'
    AlimonyInfo:
      type: object
      required:
      - alimony
      description: 'DE: Informationen über Unterhaltseinkünfte. <br/> EN: Information regarding alimony income.

        '
      properties:
        alimony:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        maritalPart:
          description: 'DE: Davon: aus Ehegattenunterhalt. <br/>

            EN: Of which: from spousal aliment.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        childPart:
          description: 'DE: Davon: aus Kindesunterhalt. <br/>

            EN: Of which: from child support.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    PersonName:
      type: object
      required:
      - gender
      - firstName
      - lastName
      properties:
        gender:
          type: string
          description: 'DE: Geschlecht der Person (nicht abschließende Aufzählung), z. B. M=männlich, F=weiblich, D=divers, UNSPECIFIED. <br/> EN: Open ended enum contains gender of the person, possible values are M=male, F=female, D=diverse, UNSPECIFIED.

            '
          x-extensible-enum:
          - M
          - F
          - D
          - UNSPECIFIED
        title:
          $ref: '#/components/schemas/Title'
        firstName:
          type: string
          description: 'DE: Vorname der Person. <br/> EN: First name of the person.

            '
        lastName:
          type: string
          description: 'DE: Nachname der Person. <br/> EN: Last name of the person.

            '
        maidenName:
          type: string
          description: 'DE: Geburtsname der Person. <br/> EN: Maiden name of the person.

            '
    CalculationType:
      type: string
      description: 'DE: Kalkulationstyp (nicht abschließende Aufzählung), z.B. HOUSEHOLD=Haushaltsrechnung, CONDITION=Konditionskalkulation, LENDING_VALUE=Beleihungswert-Kalkulation <br/> EN: Calculation type - open ended enum contains property type details, possible values are HOUSEHOLD, CONDITION, LENDING_VALUE

        '
      example: HOUSEHOLD
      x-extensible-enum:
      - HOUSEHOLD
      - CONDITION
      - LENDING_VALUE
    ExistingModernisations:
      type: object
      description: 'DE: Information über die durchgeführte Modernisierungen. <br/> EN: Complete information about modernisations that were carried out.

        '
      properties:
        yearOfLastRefurbishment:
          description: 'DE: Jahr der letzten Modernisierung. <br/> EN: Year of a the last modernisation.

            '
          $ref: '#/components/schemas/Year'
        yearOfTotalRefurbishment:
          description: 'DE: Jahr der Totalsanierung. <br/> EN: Year of a complete modernisation.

            '
          $ref: '#/components/schemas/Year'
        description:
          description: 'DE: Beschreibung über die durchgeführte Modernisierungen. <br/>

            EN: Description of modernisations that were carried out.

            '
          type: string
        totalCosts:
          description: 'DE: Gesammte Modernisierungskosten. <br/>

            EN: Total modernisation costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        breakdown:
          description: 'DE: Detailierte Information über die durchgeführte Modernisierungen. <br/>

            EN: Breakdown (details) about the modernisations that were carried out.

            '
          items:
            $ref: '#/components/schemas/ExistingModernisation'
    MaritalPropertyStatusKey:
      type: string
      description: 'DE: Beschreibung des ehelichen Güterstandes (nicht abschließende Aufzählung, zum Beispiel: COMMUNITY_OF_ACQUESTS_AND_GAINS = ZUGEWINNGEMEINSCHAFT, SEPARATION_OF_PROPERTY = GÜTERTRENNUNG, ABSOLUTE_COMMUNITY_PROPERTY = GÜTERGEMEINSCHAFT). <br/> EN: Open ended enum contains values for the matrimonial property, possible values are COMMUNITY_OF_ACQUESTS_AND_GAINS, SEPARATE_PROPERTY, ABSOLUTE_COMMUNITY_PROPERTY.

        '
      example: COMMUNITY_OF_ACQUESTS_AND_GAINS
      x-extensible-enum:
      - COMMUNITY_OF_ACQUESTS_AND_GAINS
      - SEPARATE_PROPERTY
      - ABSOLUTE_COMMUNITY_PROPERTY
      - OTHER
    SuspendedAmortizationDetails:
      type: object
      required:
      - rateType
      description: 'DE: Information zum Tilgungssurrogat. <br/> EN: Information about the repayment surrogate.

        '
      allOf:
      - $ref: '#/components/schemas/BaseRateDetails'
      properties:
        type:
          $ref: '#/components/schemas/SuspendedRepaymentProductType'
        sum:
          description: 'DE: Tilgungsbetrag. <br/>

            EN: Amortisation sum.

            '
          $ref: '#/components/schemas/EuroAmount'
        contractSignedWith:
          description: 'DE: Referenz zu den Antragsteller der den Vetrag unterschrieben hat. <br/>

            EN: Reference to the applicant who signed the contract.

            '
          $ref: '#/components/schemas/ApplicantIdRef'
        contractDuration:
          description: 'DE: Vertragsdauer. <br/>

            EN: Contract duration.

            '
          $ref: '#/components/schemas/Duration'
        upcomingPayments:
          $ref: '#/components/schemas/UpcomingPayments'
        savingBurden:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        depositValue:
          $ref: '#/components/schemas/EuroAmount'
        contractNumber:
          description: 'DE: Vertragsnummer. <br/> EN: Contract number.

            '
          type: string
        combinedProduct:
          $ref: '#/components/schemas/SuspendedAmortizationCombinedProduct'
        debtId:
          description: Id of an existing mortgage saving plan
          $ref: '#/components/schemas/DebtId'
        amortizationProvider:
          description: Amortization product in case of mortgage saving plan or company providing life insurance in case of life insurance
          type: string
        homePurchaseSavingProvider:
          $ref: '#/components/schemas/HomePurchaseSavingProvider'
        externalId:
          description: id (projection id) used to identify the product used as a suspended amortization in the bank external system
          type: string
    SelfEmploymentIncome:
      type: object
      description: 'DE: Informationen über Einkommen aus einer selbststaendigen Taetigkeit (nach Steuern). <br/> EN: Information about self-employment Income (after Tax deduction).

        '
      required:
      - income
      properties:
        income:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        details:
          $ref: '#/components/schemas/SelfEmploymentIncomeDetails'
    Title:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/TitleKey'
    ApplicantItem:
      type: object
      required:
      - applicantRef
      - person
      properties:
        applicantRef:
          description: 'DE: Id und Referenz des Antragstellers. <br/> EN: Id and reference of the applicant.

            '
          $ref: '#/components/schemas/ApplicantIdRef'
        person:
          description: 'DE: Personendaten des Antragsstellers. <br/> EN: Personal data of the applicant.

            '
          $ref: '#/components/schemas/Person'
        embedded:
          description: 'DE: Vollständige Daten des Antragsstellers. <br/> EN: Complete data of the applicant.

            '
          $ref: '#/components/schemas/Applicant'
    MarginDetails:
      type: object
      required:
      - marginCorrection
      - margins
      properties:
        margins:
          type: array
          items:
            $ref: '#/components/schemas/Margin'
        marginCorrection:
          description: Margen Korrektur; ecision 'Margenkorrektur'
          $ref: '#/components/schemas/RawPercentage'
    RepaymentPlans:
      type: object
      required:
      - plans
      properties:
        plans:
          type: array
          items:
            $ref: '#/components/schemas/RepaymentPlan'
    PublicPreFinancing:
      type: object
      required:
      - amount
      - type
      description: 'DE: Information zu einem Zwischenfinanzierung in Zusammenhang mit einer öffentlichen Vorfinanzierung. <br/> EN: Bridging debt associated with public pre-financing.

        '
      allOf:
      - $ref: '#/components/schemas/BaseBridgingLoanDetails'
      properties:
        type:
          description: 'DE: Art der öffentlichen Vorfinanzierung. <br/> EN: Type of the public pre financing.

            '
          type: string
        company:
          description: 'DE: Unternehmen, welches die öffentlichen Vorfinanzierung bereitgestellt hat. <br/> EN: Company that provided the pre-financing.

            '
          type: string
        amount:
          description: 'DE: Vorfinanzierungsbetrag. <br/>

            EN: Pre-financing amount.

            '
          $ref: '#/components/schemas/EuroAmount'
    ModernisationTypeAndScope:
      type: object
      description: 'DE: Information über den Typ und Umfang der Modernisierung. <br/>

        EN: Information about the type and scope of the modernisation.

        '
      required:
      - modernisationType
      properties:
        modernisationType:
          $ref: '#/components/schemas/ModernisationType'
        modernisationScope:
          $ref: '#/components/schemas/ModernisationScope'
    BaseProductCalculation:
      type: object
      required:
      - type
      - context
      - calculationDate
      properties:
        type:
          $ref: '#/components/schemas/CalculationType'
        context:
          $ref: '#/components/schemas/CalculationContext'
        calculationDate:
          description: 'DE: Datum der Kalkulation. <br/>

            EN: Calculation date.

            '
          $ref: '#/components/schemas/ISODate'
      discriminator:
        propertyName: type
    RealEstateGuarantees:
      type: object
      description: 'DE: Bürgschaften für die Immobilie. <br/> EN: Guarantees associated with the real estate.

        '
      properties:
        plannedSell:
          description: 'DE: Flag, ob das Immobilienvermögen vor dem Finanzierungsprozess verkauft werden soll. <br/> EN: Flag indicates whether the real estate to be sold before the financing.

            '
          type: boolean
          nullable: true
        secureFinancing:
          description: 'DE: Flag, ob das Immobilienvermögen als Zusatzsicherheit verwendet werden soll. <br/> EN: Flag indicates whether the real estate to be used to secure the financing.

            '
          type: boolean
          nullable: true
    FinancingVentureBuyExisting:
      description: 'DE: Information über das Finanzierungsvorhaben für den Kauf einer bestehender Immobilie. <br/>

        EN: Information about the financing venture to buy an existing property.

        '
      required:
      - financingNeed
      - financingDetails
      allOf:
      - $ref: '#/components/schemas/BaseFinancingVenture'
      properties:
        financingNeed:
          $ref: '#/components/schemas/ForeignEstateFinancingNeed'
        financingDetails:
          $ref: '#/components/schemas/FinancingDetails'
    RegulatoryAuthorityLegalBasisKey:
      type: string
      description: 'DE: Relevante Rechtsnorm (nicht abschließende Aufzählung), z.B. (34_C_GEWO, 34_I_GEWO siehe auch (https://www.gesetze-im-internet.de/gewo/)). <br/> EN: Open ended enum contains the relevant legal norm, possible values are (34_C_GEWO, 34_I_GEWO).

        '
      x-extensible-enum:
      - 34_C_GEWO
      - 34_I_GEWO
    ForeclosureSale:
      description: 'DE: Information über Zwangsversteigerung. <br/> EN: Information about foreclosure sale.

        '
      type: object
      properties:
        previousOwner:
          $ref: '#/components/schemas/PreviousOwner'
        estimatedValue:
          description: 'DE: Geschätzte Wert der Immobile. <br/>

            EN: Estimated property value.

            '
          $ref: '#/components/schemas/EuroAmount'
        auction:
          $ref: '#/components/schemas/AuctionInfo'
    EstateBuildingCosts:
      description: 'DE: Sammlung aller Kosten, die für den Bau der Immobilie relevant sind. <br/>

        EN: All costs associated with construction of the property.

        '
      type: object
      required:
      - construction
      properties:
        landPrice:
          description: 'DE: Grundstückpreis. <br/>

            EN: Land price.

            '
          $ref: '#/components/schemas/EuroAmount'
        construction:
          description: 'DE: Baukosten. <br/>

            EN: Construction costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        additional:
          description: 'DE: Zusätzliche Kosten. <br/>

            EN: Additional costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        outside:
          description: 'DE: Kosten der Außenanlagen. <br/>

            EN: Cost of the outdoor facilities.

            '
          $ref: '#/components/schemas/EuroAmount'
    CalculationContext:
      type: object
      description: 'DE: Kalkulation nach Art des Darlehens. <br/>

        EN: A set of financing structure contexts, which are associated with this calculation (i.e `Main` or `Nachrang` component)..

        '
      properties:
        components:
          type: array
          items:
            $ref: '#/components/schemas/CalculationContextComponent'
    LoanPartnerProcessingUnitId:
      description: 'DE: ID der Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. <br/> EN: Id of the loan partner processing unit.

        '
      required:
      - value
      properties:
        value:
          type: string
    BaseRealEstateRating:
      type: object
      description: 'DE: Information laut Immobilionbewertung. <br/> EN: Information from estate evaluation

        '
      required:
      - type
      properties:
        type:
          type: string
        marketValue:
          description: 'DE: Geschätzter Marktwert. <br/> EN: Estimated market value.

            '
          $ref: '#/components/schemas/EuroAmount'
        marketValueEvaluation:
          description: 'DE: Marktwert entsprechend einer Infoquelle (z. B. Sprengnetter). <br/> EN: Market value according to an information source (e.g. Sprengnetter).

            '
          $ref: '#/components/schemas/MarketValueEvaluation'
      discriminator:
        propertyName: type
    PropertyRegisterMortgage:
      description: 'DE: Hyptheken, Grundschulden, Rentenschulden (Eintrag aus der dritten Abteilung des Grundbuchblattes). <br/> EN: Mortgages, land charges, annuities (entry from the third section of the land register sheet).

        '
      type: object
      properties:
        serial:
          description: 'DE: Laufende Nummer im Grundbuch. <br/> EN: Serial number in land register.

            '
          type: string
        rank:
          description: 'DE: Rangstelle im Grundbuch. <br/> EN: Cadastral reference.

            '
          type: string
        inventories:
          description: 'DE: Referenzen zu den Einträgen im Bestandsverzeichnis. <br/> EN: References to the entries in the inventory.

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegisterInventoryId'
        nominalAmount:
          description: 'DE: Im Grundbuch eingetragener Betrag. <br/> EN: Amount entered in the land register.

            '
          $ref: '#/components/schemas/EuroAmount'
        cessionClaim:
          $ref: '#/components/schemas/CessionClaim'
        creditor:
          description: 'EN: Creditor DE: Gläubiger

            '
          type: string
        interest:
          description: 'EN: Interest DE: Dinglicher Zins

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        nonRecurringLoanUndertaking:
          description: 'EN: One-time value DE: Einmalvalutierung siehe [Einmalvalutierung](https://de.wikipedia.org/wiki/Einmalvalutierungserkl%C3%A4rung)

            '
          type: boolean
          nullable: true
        auxiliary:
          description: 'EN: Additional services DE: Nebenleistungen

            '
          $ref: '#/components/schemas/Percentage'
        primary:
          description: 'DE: Flag um anzuzeigen, ob der Darlehensgeber als vorrangiger Gläubiger im Grundbuch eingetragen ist. <br/> EN: Flag to indicate whether the lender is registered as primary creditor in the land register.

            '
          type: boolean
          nullable: true
        typeOfBurden:
          type: string
          description: 'DE: Art der Belastung. <br/>

            EN: Type of Burden

            '
          x-extensible-enum:
          - LAND_CHARGE
          - MORTGAGE
        residualDebt:
          description: 'DE: Restschuld. <br/>

            EN: Residual debt

            '
          $ref: '#/components/schemas/EuroAmount'
    ResourceRef:
      required:
      - href
      properties:
        href:
          type: string
          description: 'DE: Link zu einer spezifischen Ressource. <br/> EN: Link to retrieve a specific resource.

            '
          example: http://some-domain/some/link/to/somewhere
      x-skip-camel-case-check: true
    OriginInfo:
      type: object
      required:
      - client
      - externalId
      description: 'DE: Enthält die Information über Datenquelle und Daten-Identifikator aus dem externen System. <br/> EN: Contains information about Data source and data identifier in the external system.

        '
      properties:
        client:
          $ref: '#/components/schemas/Client'
        externalId:
          $ref: '#/components/schemas/ExternalId'
        intentId:
          $ref: '#/components/schemas/IntentId'
    DebtId:
      type: object
      description: 'DE: ID der Verbindlichkeit. <br/>

        EN: ID of the associated Debt.

        '
      required:
      - value
      properties:
        value:
          type: string
    OpenPropertySale:
      type: object
      description: 'DE: Information zur Zwischenfinanzierung in Zusammenhang mit einem Immobilienverkauf. <br/> EN: Information about bridging debt associated with property sale.

        '
      allOf:
      - $ref: '#/components/schemas/BaseBridgingLoanDetails'
      properties:
        debtAmount:
          description: 'DE: Aktuelle Grundschuldhöhe. <br/>

            EN: Current debt amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        residualDebt:
          description: 'DE: Aktuelle Restschuld. <br/>

            EN: Current remaining debt.

            '
          $ref: '#/components/schemas/EuroAmount'
    ApplicationSubTypeKey:
      type: string
      description: 'DE: Unterkategorie des Antragstyp (nicht abschließende Aufzählung), z.B. (NEW_APPLICANT, PROLONGATION, SUPPLEMENTARY_FINANCING). <br/>

        EN: Open ended enum contains application sub type, possible values are (NEW_APPLICANT, PROLONGATION, SUPPLEMENTARY_FINANCING).

        '
      example: NEW_APPLICANT
      x-extensible-enum:
      - NEW_APPLICANT
      - PROLONGATION
      - SUPPLEMENTARY_FINANCING
    CreditPhasePayout:
      properties:
        amount:
          description: 'DE: Bauspardarlehenssumme. <br/>

            EN: The loan amount in EUR that is provided by the Bausparkasse.

            '
          $ref: '#/components/schemas/EuroAmount'
        payoutDate:
          description: 'DE: Datum der Auszahlungsdatum. <br/>

            EN: The date on which the credit is paid out.

            '
          $ref: '#/components/schemas/ISODate'
    KfwProgram:
      type: object
      properties:
        key:
          deprecated: true
          description: '@deprecated: Use field type for the program instead.

            '
          $ref: '#/components/schemas/KfwProgramKey'
        type:
          $ref: '#/components/schemas/KfwProgramType'
    FinancingVentureBuyNew:
      description: 'DE: Information über das Finanzierungsvorhaben für den Kauf einer Neubauimmobilie. <br/>

        EN: Information about the financing venture to buy a newly built property.

        '
      required:
      - financingNeed
      - financingDetails
      allOf:
      - $ref: '#/components/schemas/BaseFinancingVenture'
      properties:
        financingNeed:
          $ref: '#/components/schemas/ForeignEstateFinancingNeed'
        financingDetails:
          description: 'DE: Finanzierungsdetails zum Kauf einer Neubauimmobilie. <br/>

            EN: Financing details relevant for purchase of newly build property.

            '
          $ref: '#/components/schemas/FinancingDetails'
        constructionStartDate:
          description: 'DE: Baubeginn des Neubaus. <br/>

            EN: Construction start date of the newly built property.

            '
          $ref: '#/components/schemas/ISODate'
    HouseholdCalculationCommandIncome:
      type: object
      required:
      - valuation
      - entries
      properties:
        value:
          description: Der vom Kunden eingetragene Wert
          $ref: '#/components/schemas/PeriodicalRawEuroAmount'
        valuation:
          description: Der von der Bank angesetzte Wert
          $ref: '#/components/schemas/PeriodicalRawEuroAmount'
        entries:
          type: array
          items:
            $ref: '#/components/schemas/HouseholdCalculationCommandEntry'
    HousingSituation:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/HousingSituationKey'
    ExistingModernisation:
      type: object
      description: 'DE: Information über die durchgeführte und geplante Modernisierungen. <br/> EN: Complete information about carried out and planned modernisations.

        '
      required:
      - modernisationTypeAndScope
      - modernisationCost
      properties:
        modernisationTypeAndScope:
          $ref: '#/components/schemas/ModernisationTypeAndScope'
        year:
          description: 'DE: Jahr der Modernisierung. <br/> EN: Year of modernisation.

            '
          $ref: '#/components/schemas/Year'
        modernisationCost:
          description: 'DE: Modernisierungskosten. <br/>

            EN: Modernisation costs.

            '
          $ref: '#/components/schemas/EuroAmount'
    ConsultationInfo:
      type: object
      deprecated: true
      x-replaced-with: Consultation.advisory
      required:
      - clientAdvisor
      description: 'DE: Informationen über die Beratung. <br/>

        EN: Information about the involved parties in the consultation phase.

        '
      properties:
        clientAdvisor:
          $ref: '#/components/schemas/OrganizationUser'
    SpecialHouseCharacteristics:
      description: 'DE: Spezielle Nutzung des Hauses. <br/> EN: Special use of the house.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSpecialRealEstateCharacteristics'
      properties:
        farm:
          description: 'DE: Bauernhof. <br/> EN: Farm.

            '
          type: boolean
          nullable: true
    OtherCapitalFinancing:
      description: 'DE: Finanzierungsrelevante Information zur Kapitalbeschaffung. <br/>

        EN: Financing-relevant information about the raising capital need.

        '
      type: object
      required:
      - neededLoan
      allOf:
      - $ref: '#/components/schemas/BaseOwnEstateFinancingNeed'
      properties:
        neededLoan:
          $ref: '#/components/schemas/OtherCapitalNeededLoan'
    PropertyRegister:
      description: 'DE: [Grundbuchinformationen](http://www.gesetze-im-internet.de/gbvfg/BJNR70

# --- truncated at 32 KB (299 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/interhyp/refs/heads/main/openapi/interhyp-pre-submission-checks-api-openapi.yml