How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Interhyp submissions API

provides endpoints for submission resources associated with a specific financing partner

Interhyp submissions API is one of 8 APIs that Interhyp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Submissions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 12 paths, and defines 644 schemas. It is described by OpenAPI 3.2.0, at version 6.10.0.

Requests are made against 3 base URLs: https://api-dev.ehyphome.de/submission/v2, https://api-acc.ehyphome.de/submission/v2, https://api.interhyp.de/submission/v2.

12 operations 12 paths 644 schemas 11 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
6.10.0
Base URL
https://api.interhyp.de/submission/v2
Authentication
custom, custom, API Key, HTTP Bearer
License
Interhyp AG
Resource Areas
1

Authentication & Security 4

Interhyp submissions API declares 4 security schemes for authenticating requests. It defines a custom scheme (BearerAuth). It defines a custom scheme (ApiKey). An API key is passed in the header as Api-Key (StandardApiKey). It accepts HTTP bearer tokens (JWT) (StandardBearerAuth). By default, every request must be authenticated.

  • StandardApiKey — API keys are unique codes issued by an API provider that allow partners to access specific API resources. By requiring an API key, the provider can ensure that…
  • StandardBearerAuth — JWT stands for JSON Web Token and is a type of bearer token that is commonly used for authentication and authorization purposes. Once retrieved, the token is s…

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 11 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

submissions 12

provides endpoints for submission resources associated with a specific financing partner

GET
/submissions
Delivers all active submissions for a specific financing partner.
getSubmissions 6 params → 200400401500
GET
/submissions/{submissionId}
Get a specific submission
getSubmissionById 2 params → 200400401404500
GET
/submissions/{submissionId}/calculations/{calculationType}
Get calculation data
getSubmissionCalculationByType 2 params → 200400401404500
POST
/submissions/{submissionId}/commands
Modify an existing submission.
modifySubmission 1 param body → 201400401500
GET
/submissions/{submissionId}/credit-loans/{creditLoanId}
Get a specific credit loan
getSubmissionCreditLoanById 2 params → 200400401404500
GET
/submissions/{submissionId}/financing-application
Get a submitted financing application
getSubmissionFinancingApplication 2 params → 200400401404500
GET
/submissions/{submissionId}/handover-documents
Get handover documents
getHandoverDocuments 1 param → 200400401403500
GET
/submissions/{submissionId}/handover/reportsdeprecated
Get handover reports
getSubmissionHandoverReports 1 param → 200202400401404500
GET
/submissions/{submissionId}/handover/reports/{name}
Get a specific handover report as PDF
getSubmissionHandoverReportByName 2 params → 200400401404500
GET
/submissions/{submissionId}/overview
Get the overview for a submission
getSubmissionOverview 1 param → 200400401404500
GET
/submissions/{submissionId}/status
Get current status of specified submission
getSubmissionStatusById 1 param → 200400401403500
GET
/submissions/{submissionId}/uploaded-documents/{documentId}/content
Get a specific submission document as PDF
getSubmissionDocumentById 2 params → 200400401404500

Schemas 644

The contract defines 644 schemas that model the data the API accepts and returns. The most detailed are Applicant (21 properties), BaseLoan (17 properties), ExistingMortgageDebt (16 properties), SuspendedAmortizationDetails (13 properties). Each schema is shown below with its type and property counts.

CreditPhaseTimeline
object
3 properties
ResidualDebtProtection
LoanQuota
object
DE: Wert und Prozentsatz für die Darlehensquote. EN: Value and percentage for a loan quota
4 properties 1 required
FixedInterestMaturity
object
DE: Information über die Sollzinsbindung mit dem festen Dauer. EN: Information about fixed interest rate maturity.
3 properties 2 required
VentureRelevantLoan
object
DE: Information über Darlehen die zu Hypothek hinzugefügt werden. EN: Information about existing loans added to the mortgage.
8 properties 2 required
ModernisationTypeKey
string
DE: Typ der Modernisierung (nicht abschließende Aufzählung), z.B. (ELECTRIC, FASSADE, FLOORPLAN=Raumaufteilung, FLOORING=Bodenbeläge, HEATING, INSTALLATION, IN…
LoanPlan
object
2 properties 2 required
TemporaryResidencePermit
object
2 properties 2 required
SolvencyCreditDebt
object
DE: Raten- und Leasingkredite. EN: Installment and leasing credits.
7 properties
AssignSubmissionLoanPartnerProcessorDetailsCommand
object
assign processing using details
1 property 1 required
RealEstate
object
DE: Allgemeine Information zu der Immobilie. EN: General information about the estate.
10 properties
AdditionalFields
object
DE: Zusätzliche Felder. EN: Additional fields.
1 property
PeriodicalEuroAmount
object
DE: Euro Betrag in einem bestimmten Zeitraum. EN: Euro amount for a specific period.
2 properties 2 required
KfwReservationInfo
object
DE: Zusätzliche Information zur KFW-Darlehensreservierung. EN: Additional Information about the Kfw Loan reservations
4 properties
ModifySubmissionCommand
BaseCounterOfferSuspendedAmortizationCombinedProduct
object
1 property 1 required
PhoneReachability
object
1 property 1 required
PauseReason
object
1 property 1 required
HouseholdCalculationCommandExpenses
object
3 properties 2 required
DefaultRealEstateRating
object
1 property
RegularPayment
object
DE: Information über den regulären Zahlungen. EN: Information about regular payment.
4 properties
VariableIncome
object
DE: Regelmäßige variable Einkünfte (netto). EN: Regular variable gross income.
2 properties 1 required
AddSubmissionLogbookNoteCommand
object
command to add Logbook note for the submission
2 properties 2 required
SignContractSubmissionCommand
object
command to sign the contract after successful credit decision.
3 properties 2 required
Prefabrication
object
1 property 1 required
Contact
object
2 properties
Client
object
1 property 1 required
EstateRef
object
DE: Id und Referenz zu der Immobilie. EN: Id and Reference to the estate.
2 properties 1 required
Building
object
DE: Information über das Gebäude. EN: Information about the building.
8 properties
ResidualDebtProtections
object
A wrapper Type to hold a set of submission residual debt protections.
1 property
BasePlannedModernisationDetails
object
1 property 1 required
ApplicantRelationshipsQuery
object
A wrapper Type to hold a set of possible relationships among applicants involved in the financing application.
1 property
CounterOfferBuildingSavingLoanSavingsPhase
object
1 property 1 required
ProcessorDetails
object
details of loan partner processor
3 properties 1 required
RefuseSignContractReason
object
1 property 1 required
BaseCalculation
object
2 properties 3 required
LandValueEvaluation
object
DE: Information über den Land Wert des Grundstücks. EN: Information about land value evaluation.
2 properties 1 required
ExistingModernisation
object
DE: Information über die durchgeführte und geplante Modernisierungen. EN: Complete information about carried out and planned modernisations.
3 properties 2 required
AssignmentForSecurity
object
DE: Sicherungsabtretung von Vermögen. EN: Equity for assignment for security.
5 properties
TextSpecialRepayment
object
DE: Sondertilgung in Textform. EN: Special repayment presented as text.
1 property 1 required
LoanPartnerProcessorEmail
object
DE: E-Mail Adresse des (Kredit-)Bearbeiters. EN: E-Mail address of the loan partner processor.
1 property
FinancingOfferStatus
object
1 property 1 required
Percentage
object
DE: Prozentsatz als double. EN: Percentage as double.
1 property 1 required
PreviousOwnerKey
string
DE: Vorheriger Immobilienbesitzer (nicht abschließende Aufzählung), z.B. THIRDPERSON, FAMILYMEMBER. EN: Open ended enum contains previous owner of the estate,…
FinancingVentureDebtRescheduling
object
DE: Information über das Finanzierungsvorhaben beim Anschlussfinanzierung / Umschuldung. EN: Information about the financing venture for follow-up financing /…
2 properties 2 required
EntryMarking
object
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 require…
3 properties 1 required
HouseholdProductCalculation
object
DE: Information zu der Haushalt Kalkulation EN: Information about the household calculation.
6 properties 5 required
CreditEntry
object
The object for a single credit entry regarding the cash flow.
4 properties 4 required
ApproveSubmissionCommissionChangeCommand
object
Approve modified commission
SuspendedAmortizationDetails
object
DE: Information zum Tilgungssurrogat. EN: Information about the repayment surrogate.
13 properties 1 required
FinancingVentureBuyNew
object
DE: Information über das Finanzierungsvorhaben für den Kauf einer Neubauimmobilie. EN: Information about the financing venture to buy a newly built property.
3 properties 2 required
LeaseInfo
object
DE: Information über ein Erbbaurecht. EN: Estate leasehold information.
1 property 1 required
BuildingSavingPlanInterestRateUpdate
object
details of building saving plan interest rate update
2 properties
FinancingApplicationId
object
DE: ID des Finanzierungsantrages EN: Financing Application identifier
1 property 1 required
Household
object
DE: Informationen zum Haushalt. EN: Information regarding a Household and it's inhabitants.
4 properties 1 required
Address
object
7 properties 2 required
HouseUtilityRentedUnitGroup
object
1 property
BuildingSavingPlanInvestEquity
object
2 properties 2 required
BaseCounterOfferLoan
object
DE: Information zum Gegenangebot Darlehen. EN: Information about the counter offer loan.
7 properties 6 required
StatSourceKey
string
DE: Infoquelle fuer den aktuellen Marktwert des Gebäudes oder Grundstuecks, z.B. MAP=Bodenrichtwertkarte, GSD, EVALCOM=Gutachterausschuss, HVB, IMMOSCOUT, IMMO…
DefaultPlannedModernisationDetails
Apartment
object
DE: Zusätzliche Information zu der Immobilie von Typ "APARTMENT" (Wohnung). EN: Additional Information for the estate with the type "APARTMENT".
7 properties
BaseRateDetails
object
4 properties 1 required
HouseholdCalculationCommandIncome
object
3 properties 2 required
ParentalAllowanceInfo
object
DE: Informationen über Elterngeld. EN: Informations regarding parental/child-raising allowance.
2 properties 1 required
ParkingSpaceTypeKey
string
CounterOfferSuspendedAmortizationCombinedProduct
FreeLancerJobTypeKey
string
DE: Freiberufliche Tätigkeit des Antragstellers (nicht abschließende Aufzählung). EN: open ended enum contains alues for the freelancer job types, possible val…
PreSubmissionCheckId
object
An Id refers to a specific pre submission check resource.
1 property
LoanPartnerProcessingUnitName
object
DE: Bezeichnung / Name der Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. EN: Name of the loan partner processing unit.
1 property
SelfEmployment
object
4 properties
CloseRejectedSubmissionCommand
object
command to close rejected submission if new active component was detected that matches with previously rejected component.
1 property
PensionIncomeBreakdown
object
DE: Details über die für den Rentenanspruch releventen Daten. EN: Breakdown for Pension entitlement details.
2 properties
RealEstateGuarantees
object
DE: Bürgschaften für die Immobilie. EN: Guarantees associated with the real estate.
2 properties
Informer
object
DE: Informationen über den Zuträger. EN: Information about informer.
6 properties
ProductType
object
1 property 1 required
RejectReason
object
1 property 1 required
HouseholdCalculationCommandEntry
object
5 properties 2 required
BridgingLoanDetails
BrokeragePlatformIdentifier
object
2 properties
DebtExpense
object
DE: Details über bereits existierende Kreditausgaben. EN: Information about periodical expenses associated with existing loans.
2 properties 2 required
ApplicationSubTypeKey
string
DE: Unterkategorie des Antragstyp (nicht abschließende Aufzählung), z.B. (NEWAPPLICANT, PROLONGATION, SUPPLEMENTARYFINANCING). EN: Open ended enum contains app…
RealEstatePropertyCondition
object
1 property 1 required
ProductCalculation
RegularEmploymentIncome
object
DE: Informationen über ein regelmäßiges Einkommen aus einem Beschaeftigungsverhaeltnis. EN: Information about regular employment income.
4 properties
EntryPeriod
object
The date object for a cashflow entry.
1 property 1 required
OfferId
object
2 properties 1 required
BaseRealEstateRating
object
DE: Information laut Immobilionbewertung. EN: Information from estate evaluation
3 properties 1 required
OwnershipInventory
object
DE: Eigentum an einem Gründstück/Objekt. EN: Ownership of a property.
1 property
BrokeragePlatform
object
2 properties 1 required
RejectSubmissionCommand
object
command to reject a submission during credit decision phase providing information about the cause of the rejection.
1 property 1 required
SubmissionAdditionalProduct
object
a specific submission additional product
10 properties 3 required
FinancingApplicationRef
object
A reference to a specific financing application resource. This reference consists of a link which leads directly to the resource and an Id which could be used…
2 properties 1 required
CreditPhaseInterest
object
2 properties
InterestMaturity
CreditPhase
object
The credit phase object (Darlehensphase).
8 properties
Processor
object
DE: Informationen zur Bearbeiter des Kreditgebers, welche die Einreichung bearbeitet. EN: The processor who is working on a submission.
2 properties 1 required
BaseForeignEstateFinancingNeed
object
DE: Finanzierungsbedarf für den Kauf oder Bau einer Immobilie EN: Financing need for buying or building an estate.
2 properties 1 required
SubmissionDataViolation
object
a specific submission violation
4 properties 1 required
CubicMeter
object
DE: Angabe in Kubikmetern. EN: Specification in cubic metres.
1 property 1 required
LoanPartnerProcessorCommandTrigger
object
3 properties
Utilization
object
DE: Wrapper für Nutzung des Ojektes EN: Wrapper for utilization of the property.
1 property 1 required
CreditLoan
object
DE: Informationen zur Finanzierungsstruktur. EN: A Credit Loan represents specific financing structure component.
3 properties
VentureRelevantLoanTypeKey
string
DE: Bestehender Darlehenstyp (nicht abschließende Aufzählung), z.B. EMPLOYMENT=Arbeitgeberdarlehen, PRIVATE=Privatdarlehen, MORTGAGESAVINGPLAN=Bauspardarlehen,…
SubmissionContractSignRefusedStatus
object
EN: Status containing information about refusing to sign the contract
1 property 2 required
OwnEstateFinancingNeed
MaritalPropertyStatus
object
1 property 1 required
UpdateSubmissionContactUserCommand
object
command to update assigned contact user of the submission
2 properties 2 required
SuspendedRepaymentProductTypeKey
string
DE: Art des Tilgungssurrogats (nicht abschließende Aufzählung), z.B. DTKAPLV, DTKAPRV, BRITKAPLV, BRITKAPRV, FONDSLV, FONDSRV, FONDSSPAR, BAUSPAR, OTHER. EN: O…
BonusIncome
object
DE: Zusätzliches regelmäßiges Einkommen durch Boni/Tantiemen. EN: Additional periodical bonus income.
3 properties
ContractSignedStatus
object
EN: Status containing information about signed contract
2 properties 1 required
HouseholdCalculation
object
DE: Information zu der Haushalt Kalkulation EN: Information about the household calculation.
3 properties
Recommendation
object
DE: Empfehlung des Beraters. EN: Financing advisor recommendations.
2 properties
Nationality
object
2 properties 2 required
ContractInfoLoanType
string
DE: Type des Loans dessen Vertragsnummer aktualisiert werden soll. EN: Type of loan where the contract number should be updated.
UnionInfo
UpdateSubmissionLoanContractNumberCommand
object
Update the contract number of a loan of a submission.
2 properties 1 required
DocumentId
object
DE: ID vom Dokument. EN: Id of the document.
1 property 1 required
PublicPreFinancing
object
DE: Information zu einem Zwischenfinanzierung in Zusammenhang mit einer öffentlichen Vorfinanzierung. EN: Bridging debt associated with public pre-financing.
3 properties 2 required
HomePurchaseSavingProvider
object
1 property 1 required
CounterOfferMainLoan
object
DE: Information zum Gegenangebot Hauptdarlehen. EN: Information about the counter offer main loan.
1 property 2 required
UpdateLoanPartnerDecisionDateCommand
object
Update the predicted decision date of a submission.
1 property 1 required
Year
objectnull
DE: Ein Jahr nach ISO-8601-Kalendersystem. EN: A year in the ISO-8601 calendar system.
1 property 1 required
FinancingDetails
BasementExtensionForResidentialUseKey
string
DE: Details zum Kellerausbau (für Wohnnutzung), z.B DEVELOPED=voll ausgebaut, PARTIALYDEVELOPED=teilweise ausgebaut, NONE=nicht ausgebaut. EN: Open ended enum…
PropertyLocation
object
DE: Information über die Lage der Immobilie. EN: Information about the estate location.
3 properties
HouseUtilityUnitGroups
object
DE: Detail zu beschreibenden Wohneinheiten. Die Beschreibung der Wohneinheiten erfolgt in Gruppen. EN: Detail to be described residential units. The residentia…
2 properties
SavingsPhase
object
Sparphase
6 properties
EstateAdditionalLoanUsageKey
string
DE: Zusätzliche Verwendung der Hypothek (nicht abschließende Aufzählung), z.B. OPERATIONALCOSTS, REPAYANOTHERLOAN, PREPAYMENTPENALTY, CONSTRUCTION, RENOVATION,…
PeriodicalRawEuroAmount
object
DE: Euro Betrag in einem bestimmten Zeitraum. EN: Euro amount for a specific period.
2 properties 2 required
HouseUtilityOwnUnitGroup
object
SubmissionCounterOfferCommandData
object
4 properties 3 required
OwnEstateFinancingDetails
object
DE: Finanzierungsdetails über das Finanzierungvorhaben der bereits besessenen Immobilie. EN: Financing details about financing process associated with already…
1 property
OriginalPurchase
object
2 properties
Paging
object
Cursor-based pagination to improve performance and minimize networks traffic, Pagination is enforced for operations that potentially could return a large colle…
6 properties
LoanConditionGeneralInfo
object
DE: Allgemeine Information zu den Darlehen (Konditionskalkulation). EN: General loan information (conditions calculation).
6 properties
Liability
object
1 property 1 required
StartProcessingSubmissionCommand
object
command to start the processing of a submission.
1 property
NationalityType
object
1 property 1 required
PersonName
object
5 properties 3 required
CycleKey
string
DE: Mögliche Zykluswerte (nicht abschließende Aufzählung), z.B. MONTHLY, QUARTERLY, HALFYEARLY, ANNUAL, ONETIME. EN: Open ended enum contains possible cycle va…
CommandId
object
1 property 1 required
PropertyRegisterOwnerEntry
object
DE: Eigentümer (Eintrag aus der zweiten Abteilung des Grundbuchblattes). EN: Owner (entry from the second section of the land register sheet).
2 properties
InformerId
object
DE: ID des Zuträgers. EN: Informer id.
1 property 1 required
ResourceRef
object
1 property 1 required
CreditPhasePayout
object
2 properties
OtherEquity
object
DE: Sonstiges Vermögen (vor der Finanzierung). EN: Other assets (before financing).
2 properties
ExistingDebtType
string
DE: Art der Darlehen (nicht abschließende Aufzaehlung EMPLOYMENT, PRIVATE, MORTGAGESAVINGPLAN, PUBLIC, OTHER, SOLVENCY, EXISTINGMORTGAGE, OPENPROPERTYSALE, EXI…
UpdateAdditionalProductsCommand
object
Modify additional products
1 property
MarginDetails
object
2 properties 2 required
RegulatoryAuthorityLegalBasisKey
string
DE: Relevante Rechtsnorm (nicht abschließende Aufzählung), z.B. (34CGEWO, 34IGEWO siehe auch (https://www.gesetze-im-internet.de/gewo/)). EN: Open ended enum c…
HousingSituationKey
string
DE: Art der derzeitigen Wohnsituation (nicht abschließende Aufzaehlung), z.B. (RENT=zur Miete, RATE=im Eigentum mit Darlehensrate, DEBTFREE=im abbezahlten Eige…
FurnishingKey
string
DE: Beurteilung der Austattung der Immobilie (nicht abschließende Aufzählung). Einflussfaktoren sind z. B. verwendete Böden, etc. EN: Open ended enum contains…
PreInquiryId
object
DE: ID des Voranfrage. EN: PreInquiry identifier.
1 property
RemainingDebtAtComponent
object
2 properties 2 required
LivingAddress
object
DE: Adresse des aktuellen oder eines früheren Wohnorts EN: address of a living place, current or past.
3 properties 2 required
PropertyType
string
DE: Art des Gebäudes (nicht abschließende Aufzählung), z.B. APARTMENT=Wohnung, DETACHEDHOUSE=Einfamilienhaus, SEMIDETACHEDHOUSE=Doppelhaushälfte, TWOFAMILYHOUS…
BaseFinancingVenture
object
DE: Vermögenswerte, welche (operativ) in die Finanzierung aufgenommen werden sollen. EN: Operational (venture) assets used in the financing process.
8 properties 2 required
EstateAdditionalLoan
object
DE: Information über ein bestehendes Darlehen (Hypothek). EN: Information about the already existing mortgage.
3 properties 1 required
LoanToValueRatioBreakdown
object
3 properties 3 required
Calculations
object
A wrapper Type to hold a set of calculations.
1 property
CancelContractReasonKey
string
DE: Grund für die Vertragskündigung, mögliche Werte sind NOTARYAPPOINTMENTUNAVAILABLE=Notartermin kann nicht rechtzeitig stattfinden, OBJECTUNAVAILABLE=Objekt…
Loan
ConstructionCostInvoiceKey
string
DE: Die Instanz, mit welcher die Abrechnung der Baukosten erfolgt. PROPERTYDEVELOPER = Bautraeger, GENERALCONTRACTOR = Generalunternehmer, ARCHITECT = Architek…
PropertyRegister
object
DE: [Grundbuchinformationen](http://www.gesetze-im-internet.de/gbvfg/BJNR706370935.htmlBJNR706370935BJNG000402307). EN: Information according to the property /…
5 properties 1 required
MaritalStatus
object
1 property 1 required
AuxProductTypeKey
string
DE: Typ des Nachrangdarlehens (nicht abschließende Aufzählung), z.B. DSLPRIVAT, OYAKANKER, HANSEATICALL. EN: Open ended enum contains auxiliary loan product ty…
Person
object
DE: Personendaten einer Person. EN: Personal data of a person.
4 properties 1 required
PropertyRegisterOwnerApplicant
object
1 property 1 required
SelfEmploymentIncome
object
DE: Informationen über Einkommen aus einer selbststaendigen Taetigkeit (nach Steuern). EN: Information about self-employment Income (after Tax deduction).
2 properties 1 required
SystemCommandTrigger
object
2 properties 1 required
SubmissionCounterOfferRejectedStatus
object
EN: Status containing information about counteroffer that was rejected
1 property 2 required
HouseUtilityUnits
object
DE: Wohn- und Nutzeinheiten. EN: Residential and utility units.
2 properties
AdvisoryDetails
object
DE: Informationen über die Beratung. EN: Information about the involved parties in the consultation phase
4 properties 3 required
SavingsPlanInterest
object
2 properties
RFC7807Problem
object
DE: Angaben zum zurueckgegebenen Fehler. EN: Holds information on the returned error.
8 properties 5 required
Executive
object
4 properties
KfwPromotionLoan
object
DE: Information zum Kfw-Darlehen. EN: Information about the KFW promotion loan.
4 properties
DefaultSpecialRealEstateCharacteristics
SubmissionRef
object
A reference to a specific submisson resource. This reference consists of a link which leads directly to the resource and an Id which could be used to reconstru…
2 properties
FreeLancerJobType
object
DE: Art der freiberuflichen Tätigkeit. EN: Freelancer job type.
1 property 1 required
Neighbourhood
object
1 property 1 required
BaseHouseUtilityUnitGroup
object
6 properties 1 required
SpecialRepaymentType
string
DE: Typ der speziellen Rückzahlung (nicht abschließende Aufzählung), z.B. PERCENTAGE, TEXT. EN: Open ended enum contains possible special repayment types, poss…
CalculationBaseRate
object
2 properties 1 required
SubmissionContractCanceledStatus
object
EN: Status containing information about cancelling the contract
2 properties 3 required
SpecialRealEstateCharacteristics
FinancingApplicationItem
object
A wrapper type Holds information about the requested financing application. Further details will be delivered in the embedded property if specified. Please ref…
2 properties 2 required
PrefabricationKey
string
DE: Besonderheiten der Bauart (nicht abschließende Aufzählung), z.B NOSPECIFICS=keineBesonderheiten, PREFABRICATEDFertighaus, BAREBONESHOUSEAusbauhaus, CONSTRU…
PhoneTypeKey
string
DE: Art der Telefonnummer (nicht abschließende Aufzählung, zum Beispiel: MOBILE = Mobilfunknummer, LANDLINE = Festnetznummer, UNSPECIFIED = nicht angegeben, MO…
SelfEmploymentIncomeItem
object
DE: Informationen zum Einkommen aus selbständiger Tätigkeit für ein Jahr EN: Describes the self employment income information for a year.
5 properties
SpecialPropertyTypeKey
string
DE: Sondereigentumstyp (nicht abschließende Aufzählung), z.B. BASEMENT, HOBBY, DRYINGROOM, ATTIC, OFFICE, APARTMENT, ALLROOMS, GARAGE, OUTPARK, UGPARK, DUPLEXP…
CalculationItem
object
2 properties
BaseProductCalculation
object
3 properties 3 required
ResidualDebtProtectionType
string
DE: Art der Restschuldabsicherung (nicht abschließende Aufzählung), z.B. BUILDINGSAVINGPLAN. EN: Open ended enum contains possible residual debt protection typ…
PlannedModernisationDetails
UserData
object
4 properties
PeriodicalEuroAmountPerSquareMeter
object
DE: Euro Betrag pro Quadratmeter in einem bestimmten Zeitraum. EN: Euro amount per square meter for a specific period.
1 property 1 required
TitleKey
string
DE: Akademischer Titel des Antragstellers (nicht abschließende Aufzählung, zum Beispiel: DR, PHD, PDDR, PROF, PROFDR). EN: Open ended enum contains possible ti…
ExternalProcessingDetail
object
1 property 1 required
BaseResidualDebtProtection
object
DE: Eine Restschuldabsicherung für eine der Tranchen. Wird über die LoanId referenziert, falls es mit einer Tranche verbunden ist. EN: A residual debt protecti…
4 properties 3 required
PreSubmissionCheckItems
object
Collection of performed pre-submission checks
1 property 1 required
SelfEmploymentIncomeMethod
object
1 property 1 required
ApplicantItem
object
3 properties 2 required
InvestEquity
object
DE: Vermögenswerte, welche (operativ) in die Finanzierung aufgenommen werden sollen. EN: Operational (venture) assets used in the financing process.
9 properties
PeriodicalRawPercentage
object
DE: Periodischer Prozentsatz. EN: Periodical percentage.
2 properties 2 required
BaseOccupation
object
4 properties 1 required
LoanType
string
DE: Art des Darlehens (nicht abschließende Aufzählung), z.B. MAINLOAN, AUXILIARYLOAN, KFWPROMOTIONLOAN. EN: Open ended enum contains possible loan types, possi…
LoanConditionDetail
object
DE: Information über einzelnen Darlehen innerhalb des Konditionskalkulations. EN: Information about single loan which is a part of condition calculation.
8 properties
DefaultUnionInfo
EstateItem
object
A wrapper that holds basic information about estate.
3 properties 2 required
EnergyEfficiency
object
DE: Information bzgl. der Energieeffizienz. EN: Information the regarding the energy efficency.
7 properties
DebtReschedulingFinancing
object
DE: Finanzierungsrelevante Information zur Anschlussfinanzierung / Umschuldung. EN: Financing-relevant information for the follow-up financing / rescheduling.
1 property
ParentalLeave
object
DE: Beschreibt ein (Angestelltes) Beschäftigungsverhältnis das wegen Elternzeit aktuell ruht EN: Describes an employment that is currently paused due to parent…
2 properties 2 required
CreateSubmissionCounterOfferCommand
object
command to create a counter offer for a specific submission providing all needed information during credit decision phase.
1 property 1 required
HouseUtilityUnitGroup
PlannedModernisation
object
DE: Information über die geplante Modernisierungen. EN: Information about planed modernisations.
5 properties 1 required
AdditionalInfo
object
DE: Zusätzliche Information als Schlüssel-Wert Paar. EN: Additional Information as key-value pairs.
2 properties
InterestRate
object
DE: Information über den Zins. EN: Information about the interest rate.
2 properties
ApplicantRelationships
object
A wrapper Type to hold a set of possible relationships among applicants involved in the financing application.
2 properties
BaseExistingLoanDebt
object
DE: Finanzierungsrelevante Darlehen. EN: Existing loan debt. An Existing debt could be any of the following types: - EMPLOYMENT - PRIVATE - MORTGAGESAVINGPLAN…
4 properties 2 required
ContractLimitation
object
DE: Informationen ob der Vertrag befristet ist. EN: Information about contract limitation.
1 property 1 required
HousingSituation
object
1 property 1 required
ShortTimeWork
object
DE: Kurzarbeit EN: Short time work.
3 properties
FamilyIncome
object
DE: Zusätzliches regelmäßiges Einkommen durch bzw. für Kinder / Familie. EN: Additional periodical income for children / family.
3 properties
BasementDetail
object
1 property 1 required
FinancialVentureItem
object
DE: Relevante Information zu dem geplanten Finanziehrungsvorhaben. EN: Information about planed financing venture.
5 properties 3 required
PropertiesRegisterInventory
VentureRelevantLoanType
object
1 property 1 required
BaseSuspendedAmortizationCombinedProduct
object
1 property 1 required
Applicant
object
DE: Detaillierte Informationen des Antragstellers. EN: Detailed information about the applicant.
21 properties 2 required
SavingsAndRepayment
object
Defines the savings and the repayment plan for a building savings plan (Bausparer Spar und Tilgungsplan)
2 properties 2 required
SchufaRating
object
DE: Bewertung der Kreditwürdigkeit des Antragstellers durch die Schufa. EN: Rating of the credit worthiness by Schufa.
3 properties 1 required
LoanPartnerProcessor
object
DE: Der (Kredit-)Bearbeiter. EN: The loan partner processor.
3 properties 2 required
EuroAmount
object
DE: Euro Betrag as double. EN: Euro amount as double
1 property 1 required
ExtendedContractInfo
object
DE: Vertragsnummer mit Referenznummer ID. EN: Contract number and reference id pair with additional loan details.
4 properties 3 required
OpenPropertySale
object
DE: Information zur Zwischenfinanzierung in Zusammenhang mit einem Immobilienverkauf. EN: Information about bridging debt associated with property sale.
2 properties
InhabitantsKey
string
DE: Anzahl Einwohner im Ort (nicht abschließende Aufzählung), z.B. UPTO1000, UPTO10000, UPTO50000, UPTO100000, UPTO200000, UPTO500000, UPTO1000000, MORETHEN100…
FinancingApplicationStatusKey
string
DE: Status des Finanzierungsantrages. EN: Status of the application.
Construction
object
1 property 1 required
MainProductType
string
DE: Produkttyp des Darlehens (nicht abschließende Aufzählung), z.B. (ANNUITAET=Annuitätendarlehen, WRIESTER=Wohnriesterdarlehen, ZWIFI=Zwischenfinanzierung, FL…
CalculationDetail
object
DE: Detailierte Information über einen Eintrag in der Kalkulation. EN: Detailed information about single entry in the calculation.
7 properties
JobProbation
object
1 property 1 required
SubmissionRejectedStatus
object
EN: Status containing information about rejection
1 property 2 required
PreInquires
object
1 property 1 required
CounterOfferRateDetails
KfwProgramType
string
DE: KFW-Förderprogramm (nicht abschließende Aufzählung), z.B. KFW124, KFW151, KFW152, KFW153, KFW159, KFW167. EN: Open ended enum contains possible programs fo…
SubmissionDataViolationSeverityKey
string
ISODateTime
stringnull
DE: Datum, Syntax nach RFC 3339 EN: Date according to RFC 3339
LoanQuotaType
object
DE: Wrapper für Ursprung des Wertes der Darlehensquote EN: Wrapper for loan quota value types.
1 property 1 required
BaseVendor
object
3 properties 1 required
RepaymentPlan
object
4 properties
JobInformation
object
DE: Stellenbeschreibung der Tätigkeit. EN: Detailed information about the specified job.
4 properties
RevokeSubmissionRejectionCommand
object
command to revert a rejection of a submission during credit decision phase.
1 property
RawEuroAmount
object
DE: Euro Betrag als Zahl. EN: Euro amount as number
1 property 1 required
Salary
object
DE: Informationen über das Gehalt. EN: Information regarding salary.
4 properties 1 required
ExternalProcessing
object
EN: Information regarding the external processing
3 properties 1 required
ModernisationTypeAndScope
object
DE: Information über den Typ und Umfang der Modernisierung. EN: Information about the type and scope of the modernisation.
2 properties 1 required
SubmissionRevokedReason
object
1 property 1 required
OtherCapitalNeededLoanUsage
object
1 property 1 required
AtticDetailKey
string
DE: Details zum Dachgeschoss (nicht abschließende Aufzählung), z.B DEVELOPED=ausgebaut, UPGRADEABLE=ausbaufähig, NOTUPGRADEABLE=nichtausbaufähig. EN: open ende…
FinancialStandings
object
Wrapper Type holds set of Financial Standings.
2 properties 1 required
BasePropertyRegisterOwner
object
DE: Information über den Eigentümer. EN: Information about property owner.
1 property 1 required
SimpleLoanDebt
object
DE: Information zu bestehenden Darlehen. EN: Information about existing debts.
5 properties 2 required
MarkingName
string
PauseReasonKey
string
FinancingNeedType
string
SaleInformation
object
DE: Information über den Objektverkauf. EN: Object sale information.
4 properties
AnnuityDetails
object
DE: Detaillierte Information über das Annuitätsdarlehen. EN: Detailed information about periodic loan.
2 properties 1 required
CapitalIncome
object
DE: Zusätzliches regelmäßiges Einkommen durch Kapitalvermögen. EN: Additional periodical income from capital.
3 properties
PeriodicalCreditEntry
object
LiabilityDebt
object
DE: Verbindlichkeiten vor Beginn der angefragten Finanzierung. EN: Liability obligations before the financing process.
3 properties
PropertyRegisterOwnerThirdPerson
object
2 properties
ResponsiblePersonTypeKey
string
DE: Rolle der zuständigen Person (nicht abschließende Aufzählung), z.B. (PROCESSOR=Ansprechpartner, MANAGER=Führungskraft). EN: Open ended enum contains the ro…
Cursor
object
A cursor refers to a random string of characters which marks a specific item in a collection of data. The cursor will always point to the item, however it will…
2 properties
AuxiliaryIncome
object
DE: Regelmäßige Nebeneinkünfte. EN: Periodical auxiliary income.
2 properties 1 required
RealEstateRating
CreditWorthiness
PayoutInfo
object
DE: Information zur Auszahlung des Darlehens. EN: Loan payout information.
3 properties
Basement
object
DE: Information über den Keller. EN: Information about building basement.
3 properties
Inhabitants
object
1 property 1 required
AdvisorCommandTrigger
object
1 property 1 required
EstateVendor
DE: Informationen über den Immobilienverkäufer. EN: Information about the estate vendor.
ArchiveSubmissionCommand
object
Mark a submission as archived.
PropertyRegisterInventoryId
object
DE: Laufende Nummer eines Grundstücks/Eigentum. EN: Serial number of the property.
1 property 1 required
DocumentMetaData
object
6 properties
RepaymentEntriesAggregated
object
4 properties 4 required
SubmissionStatus
BusinessLine
object
1 property 1 required
LiabilityKey
string
DE: Art des Kredits ( CONSUMERCREDIT=Konsumentenkredit, CARCREDIT=Autokredit, LINEOFCREDIT=Rahmenkredit, CALLCREDIT=Abrufkredit, BUSINESSCREDIT=Geschäftskredit…
ConstructionKey
string
DE: Bauweise des Gebäudes (nicht abschließende Aufzählung), z.B. SOLID=Massivbauweise, CONCRETESLAB=Plattenbauweise, WOODSTAND=Holzständerbauweise, WOOD=Holzba…
RegulatoryAuthorityLegalBasis
object
1 property 1 required
ConsultationInfo
object
DE: Informationen über die Beratung. EN: Information about the involved parties in the consultation phase.
1 property 1 required
TaxableIncome
object
DE: Steuerpflichtiges Einkommen für ein bestimmtes Jahr. EN: Taxable income for a specific years.
2 properties 2 required
PeriodicalPercentage
object
DE: Periodischer Prozentsatz als double. EN: Periodical percentage as double.
2 properties 2 required
ContractInfoReferenceId
object
DE: Referenz zu einem Baustein, dessen Vertragsnummer aktualisiert werden soll. EN: Reference to a component whose contract number should be updated.
1 property
ClientKey
string
DE: Datenquelle, mögliche Werte: INTERHYPASP, COBAASP. EN: Enum representing data origin, possible values are INTERHYPASP, COBAASP.
SuspendedAmortizationCombinedProduct
LoanPartnerQueue
object
DE: Informationen zur Kredigeber Warteschlange. EN: Information about loan partner queue.
3 properties 1 required
BuildingSavingPlanEquity
object
DE: Details über vorhandene Bestandsbausparer Guthaben (vor der Finanzierung). EN: details about existing building saving plan equity (before financing).
7 properties 2 required
SubmissionId
object
An Id refers to a specific submission resource.
1 property 1 required
ISODate
stringnull
DE: Datum, Syntax nach RFC 3339 EN: Date according to RFC 3339
ExtendedPeriodicalSavingsEntry
object
Savings plan (Sparplan, Summe Sparplan, letzte Periode Sparplan) including marking for special entries.
1 property
ResidualDebtId
object
DE: Id der Restschuldabsicherung. EN: Id of the residual debt protection.
1 property
PlanTemplate
string
Describes the repayment plan template based on the conditions of the corresponding loan. - standard: until the end of the fixed interest rate - lifetime: until…
CreditLoans
object
A wrapper Type to hold a set of submission credit loans.
1 property
DeliverContractSubmissionCommand
object
command to hand over the contract after successful credit decision.
3 properties 2 required
CompanyId
object
DE: ID des Unternehmes. EN: ID of the company.
1 property 1 required
FinancingOfferItem
object
DE: Referenz zum Finanzierungsangebot. EN: Reference to the financing offer.
2 properties 1 required
SelfEmploymentIncomeMethodKey
string
DE: Berechnungsmethode für das Einkommen (nicht abschließende Aufzaehlung), z.B. (CUSTOMERSPECIFICATION=Kundenangabe, PROFITANDLOSSACCOUNT=Gewinn- und Verlustr…
OAuthProblem
object
Error while Authentication
2 properties 2 required
ParkingSpaceType
object
1 property 1 required
LoanToValueRatioProductCalculation
object
DE: Information zu der Kalkulation EN: Information about the calculation.
3 properties 3 required
CounterOfferSuspendedAmortizationRateDetails
object
1 property
Bic
object
DE: BIC EN: The Business Identifier Code
1 property 1 required
OtherCapitalNeededLoanUsageKey
string
DE: Zusätzlicher Kapitalbedarf (nicht abschließende Aufzählung), z.B. OPERATIONALCOSTS, REPAYANOTHERLOAN, PREPAYMENTPENALTY, RESIDENTIALUSE, RENEWABLEENERGY, D…
SubmissionRevokedReasonKey
string
DE: open ended enum enthält mögliche Gründe für den Widerruf der Anmeldung EN: open ended enum contains possible submission revocation reasons
PeriodicalRepaymentEntry
object
8 properties 4 required
ExistingMortgageDebt
object
DE: Bestehende Hypothek auf die Immobilie. EN: Existing mortgage of the property.
16 properties 1 required
KfwLoanAdditionalInfo
object
DE: Zustzäliche Information zum KFW Darlehen. EN: Additional informations for kfw loan.
1 property
LoanToValueRatioLoanBreakdown
object
2 properties 1 required
RealEstateEquityItem
object
DE: Informationen zu einem bestimmten Eigenkapital durch Immobilienvermögen. EN: Details about a specific real estate equity.
4 properties 2 required
Company
object
DE: Informationen zu einem Unternehmen. EN: Information of a company.
2 properties 1 required
BuyExistingEstateFinancing
object
DE: Finanzierungsrelevante Information zu dem Kauf bestehender Immobilie. EN: Financing-relevant information for the purchase of an existing property.
5 properties 1 required
ConditionProductCalculation
object
DE: Information über Konditionskalkulation. EN: Information about condition calculation.
3 properties 3 required
FinancialBurdenDetail
object
DE: Detailierte Information über den Belastungsplan innerhalb der Haushaltsrechnung. EN: Detailed information about financial burden within household calculati…
6 properties
Child
object
DE: beschreibt ein Kind (Im Umfang der Daten reduzierte Person) EN: a child is a segment of the data of a person
5 properties 2 required
PersonVendor
object
1 property 2 required
Violation
object
DE: Ein Verstoss gegen die Schnittstellenspezifikation. EN: A violation against the API schema.
2 properties
FinancialStandingItem
object
Holds basic information associated with a specific financial standing type and whom it belongs. Further details will be delivered in the embedded property if s…
4 properties
RevokeSubmissionCounterOfferReasonKey
string
DE: Grund für den Entzug, mögliche Werte sind COUNTEROFFEREXPIRED=Gegenangebot kann nicht mehr aufrechterhalten werden, READJUSTCOUNTEROFFER=Gegenangebot soll…
BaseSubmissionStatus
object
EN: Basic submission status representation
3 properties 1 required
BaseCreditWorthiness
object
DE: Informationen über die Kreditwürdigkeit des Antragstellers (zum Beispiel Schufa Score). EN: Information regarding credit worthiness (like Schufa-Score).
1 property 1 required
BuildingSavingsPlan
object
Savings plan (Sparplan, Summe Sparplan, letzte Periode Sparplan) including marking for special entries.
2 properties 2 required
JointOwnershipInventory
object
DE: Miteigentumsanteil an einem Gründstück/Objekt. EN: Co-ownership of a property.
3 properties
ParkingSpace
object
DE: Information über den Parkplatz. EN: Information about the parking space.
3 properties 1 required
RegisterCover
object
DE: Grundbuchdaten. EN: General information about the land register sheet.
5 properties
NationalityTypeKey
string
DE: Art der Staatsbürgerschaft (nicht abschließende Aufzählung, zum Beispiel FIRST = Erste Staatsbürgerschaft, SECOND = Zweite Staatsbürgerschaft). EN: Open en…
Estates
object
A wrapper type of items which hold the essential estate information.
1 property 1 required
Calculation
RentalIncomeItem
object
DE: Mieteinnahmen aus einem bestimmten Objekt. EN: The rental income for a specific real estate.
2 properties 2 required
ClosedPropertySale
DE: Information zur Zwischenfinanzierung in Zusammenhang mit einem abgeschlossenen Immobilienverkauf. EN: Bridging debt associated with a closed property sale.
Plot
object
DE: Zusätzliche Information zu der Immobilie von Typ "PLOT" (Grundstück). EN: Additional information for the estate with the type "PLOT".
4 properties
ExistingLoanDebt
EvaluationInformation
object
3 properties
LendingValueCalculation
object
DE: Information zu der Kalkulation EN: Information about the calculation.
2 properties
AreaInfo
object
DE: Information über die gesamte Wohn- und Nutzfläche. EN: Information about the total residential and useable area.
5 properties
CalculationContextComponent
object
2 properties
AwaitExternalProcessingSubmissionCommand
object
command to indicate that the processing will be stopped due to an external process e.g. object valuation etc, and is not related to the submission's quality
1 property 1 required
AlimonyExpenseDetail
object
3 properties 2 required
HandoverReports
object
A wrapper Type to hold a set of handover reports references.
1 property 1 required
AtticDetail
object
1 property 1 required
AdditionalField
object
DE: Zusätzliche Feldinformationen. EN: Additional field info.
4 properties 3 required
ContractDeliveredStatus
object
EN: Status containing information about delivered contract
2 properties 1 required
RejectSubmissionCounterOfferCommand
object
command to reject a counter offer.
3 properties 3 required
EstateAdditionalLoanUsage
object
1 property 1 required
InventorySpecialProperty
object
2 properties
OfferFinancingNeed
object
DE: Information über den Finanzierungswunsch der finanziert werden sollten. EN: Information about the financing need.
3 properties
ExistingRealEstateDebt
object
11 properties 1 required
AuxProductType
object
1 property 1 required
SelfEmploymentIncomeDetails
object
DE: Berechnung des selbstständigen Einkommens. EN: Calculation of independent (self employment) income.
4 properties
Submissions
object
A wrapper Type to hold a set of submission references and paging metadata.
2 properties 1 required
ExternalProcessingReason
string
EN: Open ended enum contains possible reasons for external processing (EXTERNALEXPERTASSESSMENT, INTERNALEXPERTASSESSMENT, DECISIONINTERNALUNIT, CONTRACTCREATI…
BaseFinancingDetails
object
DE: Detailierte Information über das Finanzierungvorhaben. EN: Detailed information about the financing process.
6 properties 1 required
SubmissionDocumentBinary
string
SubmissionTimeline
object
DE: Zeitplan einer Einreichung. EN: Timeline of a submission.
1 property
KfwProgramKey
string
DE: KFW-Förderprogramm (nicht abschließende Aufzählung), z.B. Wohneigen, Wohn159, Energie153-40, Energie151, Energie152, Energie167. EN: Open ended enum contai…
PreInquiry
object
3 properties
RefuseSignContractCommand
object
command to indicate that a customer refused to sign a contract.
2 properties 1 required
PlannedModernisations
object
DE: Wertsteigernde Maßnahmen bei der Modernisierung EN: Value-enhancing renovations
5 properties
SavingsPlanTimeline
object
3 properties
ForwardExistingMortgage
object
DE: Das Darlehen soll erst nach einer bestimmten Vorlaufzeit ausgezahlt werden. EN: Loan shall be released.
1 property
ApproveSubmissionCommand
object
command to approve a submission during credit decision phase providing information.
1 property
ApplicationSubType
object
1 property 1 required
FinancialStandingId
object
Id of a specific FinancialStanding.
1 property 1 required
SubmissionCounterOffer
object
4 properties
RealEstateEquity
object
DE: Eigenkapital durch Immobilienvermögen. EN: Real estate equity.
4 properties 1 required
BasePropertiesRegisterInventory
object
DE: Grundstück und Eigentum (Eintrag aus dem Bestandsverzeichnis des Grundbuchblattes). EN: Land and property (Entry from the inventory of the land register sh…
5 properties 2 required
AlimonyInfo
object
DE: Informationen über Unterhaltseinkünfte. EN: Information regarding alimony income.
3 properties 1 required
ResidualDebtProtectionBuildingSavingPlan
MainLoanAdditionalInfo
object
DE: Zustzäliche Information zum Hauptdarlehen. EN: Additional informations for main loan.
2 properties
FinancingStructures
object
DE: Information über die Struktur der Finanzierung. EN: Information about the financing structure.
7 properties
HandoverReportBinary
string
SubmissionOverview
object
DE: Generelle Informationen ueber den Kreditantrag. EN: General information about a specific submission.
13 properties
SavingsPlanFees
object
3 properties
FinancingApplication
object
12 properties 5 required
BaseUnionInfo
object
DE: Informationen zu Verbands- bzw. Gewerkschaftszugehörigkeit EN: Information regarding union membership
2 properties 2 required
BaseBridgingLoanDetails
object
DE: Information zur Zwischenfinanzierung. EN: Details about bridging loan.
3 properties 2 required
SubmissionDefaultStatus
OfferFinancingNeedCost
object
DE: Kosten verbunden mit der gewünschten Finanzierung. EN: Costs associated with the wanted financing.
2 properties
CounterOfferBuildingSavingLoan
object
DE: Information zum Gegenangebot Bausparer. EN: Information about the counter offer building saving loan. type: object
4 properties 4 required
BuildingSavingPlan
object
DE: Information zum Bauspardarlehen. EN: Information about the building saving loan.
11 properties
OtherExpense
object
DE: Andere (zusätzliche) regelmäßige Ausgaben. EN: Other periodical expenses.
2 properties 1 required
LoanConditionSummary
object
DE: Zusammenfassung von Informationen zu einzelnem Darlehen (Konditionskalkulation). EN: Summary information about single loan (conditions calculation).
4 properties
BaseFinancingNeed
object
2 properties 1 required
CreditLoanId
object
DE: Id der Finanzierungsstruktur. EN: Credit Loan identifier.
1 property 1 required
BaseMainProduct
object
DE: Information zum Hauptdarlehensprodukt. EN: Main loan product information.
2 properties 1 required
ExternalId
object
DE: Daten-Identifikator aus dem externen System. EN: Data identifier in the external system.
1 property
OtherIncome
object
DE: Anderes (zusätzliches) regelmäßiges Einkommen. EN: Other periodical income.
3 properties 1 required
PensionIncome
object
DE: Regelmäßiges Einkommen aus Rente/Pension. EN: Periodical income from pension.
2 properties 1 required
Title
object
1 property 1 required
ChangeLoanPartnerProcessingUnitCommand
object
command to change assigned loan partner processing unit
3 properties
FinancingVenture
ForeignEstateFinancingDetails
object
DE: Finanzierungsdetails über das Finanzierungvorhaben der Immobilie die erworben wird. EN: Financing details about financing process associated with the prope…
3 properties
PreviousOwner
object
1 property 1 required
DetailType
string
DE: Kategorie des Kalkulkationwertes (nicht abschließende Aufzählung), z.B. ENTRY, SUBTOTAL. EN: Calculated value category - open ended enum contains property…
ProcessingUnit
object
DE: Informationen zur Einheit des Kreditgebers, welche die Einreichung bearbeitet. EN: Id of the loan partner processing unit.
2 properties 1 required
CreditDecisionDocumentMetaData
object
1 property
InitialSubmissionEstimate
object
DE: Voraussichtliches Entscheidungsdatum. EN: Estimated decision date.
1 property
LocalPriceDetails
object
DE: Ortsüblicher Preis pro Quadratmeter Wohnfläche. EN: Local price per square meter of living space.
2 properties
RentInfo
object
DE: Information über die Vermietung. EN: Rent information.
5 properties
Income
object
DE: Ein Untertyp von "Financial Standing", welcher alle Informationen zu den Einkünften beinhaltet. EN: A specific financial standing type holds all informatio…
8 properties 1 required
RateDetails
MarketValueEvaluation
object
DE: Information über eine externe Marktbewertung. EN: Information about external market value evaluation.
2 properties 1 required
LoanId
object
DE: ID des Darlehens. EN: Loan identifier.
1 property
CompanyAdvisor
object
3 properties 1 required
AnnuityInterestRateUpdate
object
details of annuity interest rate update
2 properties
PreInquiryStatus
object
1 property 1 required
ExtendedPeriodicalCreditEntry
object
The credit entries including markings for special entries.
1 property
LoanPartnerProcessingUnit
object
DE: Informationen zur Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. EN: Information about the processing unit of the financing partner.
3 properties 1 required
EvaluationInformationContactData
object
2 properties
AdditionalApplicants
object
DE: Nebenantragssteller für das Finanzierungsvorhaben. EN: Additional applicants for the financing venture.
1 property
BaseInterestMaturity
object
1 property 1 required
InsuranceExpense
object
DE: Informationen über Ausgaben durch Versicherungen. EN: Informations related insurance expences.
4 properties
FinancialStandingType
string
DE: Finanzstatus (nicht abschließende Aufzählung), z.B. (EQUITY, DEBT, INCOME, EXPENSE). EN: Open ended enum contains possible types financial standing, possib…
OccupationType
string
DE: Beschreibung der Beschäftigungsart (nicht abschließende Aufzählung, zum Beispiel: EMPLOYEE = ANGESTELLTE/R, WORKER = ARBEITER/IN, UNEMPLOYED = ARBEITSLOSE/…
EstateBuildingCosts
object
DE: Sammlung aller Kosten, die für den Bau der Immobilie relevant sind. EN: All costs associated with construction of the property.
4 properties 1 required
ModernisationScope
object
1 property 1 required
SavingPlanTariff
object
6 properties 3 required
ParcelAndDistrict
object
DE: Information über Gemarktung und Flurstück. EN: Information about the cadastral district and the land parcel.
3 properties 1 required
BrokeragePlatformIdentifierKey
string
DE: Interne Vermittler Quelle, wichtig für ermitteln des Vermittlernummers. EN: Advisor company key, used to determine company identifier.
BuildEstateFinancing
object
DE: Finanzierungsrelevante Information zu dem Bau der Immobilie. EN: Financing-relevant information for the construction of the property.
2 properties 1 required
PercentageSpecialRepayment
object
DE: Sondertilgung in Prozent pro Periode. EN: Special repayment presented as percent per period.
2 properties 1 required
HomePurchaseSavingProviderKey
string
Home purchase saving plan provider (BHWDISPO - BHW, DEUTDEFF - Deutsche Bank, ALTEDEFA - Alte Leipziger, LBS - LBS, BSWLDE - Wüstenrot, STARTBS - start:bauspar…
AuctionInfo
object
DE: Information zur Immobilienauktion. EN: Information about the estate auction.
3 properties
BaseSpecialRepayment
object
DE: Information zur Sondertilgung. EN: Special repayment information.
1 property 1 required
FinancialStandingRef
object
A Reference to a specific FinancialStanding. This reference consists of a link leads directly to the resource and an Id which could be used to reconstruct the…
2 properties
AuxiliaryLoan
object
DE: Information zum Nachrangdarlehen. EN: Information about the auxiliary loan.
2 properties 1 required
RevokeSubmissionCounterOfferCommand
object
command to revoke a counter offer.
3 properties 2 required
BasementDetailKey
string
DE: Details zum Keller (nicht abschließende Aufzählung), z.B DEVELOPED=vollunterkellert, PARTIALYDEVELOPED=teilunterkellert, NONE=nichtunterkellert. EN: Open e…
ExistingLoanExpenses
object
Wrapper Type holds a set of periodical expenses associated with existing credits.
1 property
ResponsiblePersonType
object
1 property 1 required
PlannedHeatingModernisationDetails
object
DE: Information über die geplante Modernisierungen der Heizung. EN: Information about planned heating modernisations.
3 properties 3 required
PaymentTimeKey
string
DE: Mögliche Zahlungszeit-Arten (nicht abschließende Aufzählung), z.B. ADVANCE=Vorschüssig, ARREARS=Nachschüssig. EN: Open ended enum contains possible payment…
HandoverReport
object
DE: Metadaten zur den Einreichungsunterlagen. EN: Metadata regarding the system generated reports for a specific submission. Handover reports including but not…
5 properties 3 required
SubmissionRevokedStatus
object
EN: Status containing information about revocation
4 properties 2 required
LoanConditionInterest
object
DE: Zusammenfassung von Informationen zu einzelnem Darlehen (Konditionskalkulation). EN: Summary information about single loan (conditions calculation).
2 properties 2 required
BaseRealEstate
object
10 properties 2 required
CompanyName
object
1 property
MaritalPropertyStatusKey
string
DE: Beschreibung des ehelichen Güterstandes (nicht abschließende Aufzählung, zum Beispiel: COMMUNITYOFACQUESTSANDGAINS = ZUGEWINNGEMEINSCHAFT, SEPARATIONOFPROP…
OrganizationCompany
object
5 properties
RejectReasonKey
string
Households
object
A wrapper Type to hold a set of households associated with the financing application.
2 properties
RepaymentPlans
object
1 property 1 required
CalculationType
string
DE: Kalkulationstyp (nicht abschließende Aufzählung), z.B. HOUSEHOLD=Haushaltsrechnung, CONDITION=Konditionskalkulation, LENDINGVALUE=Beleihungswert-Kalkulatio…
HouseholdsQuery
object
A wrapper Type to hold a set of households associated with the financing application.
1 property
CommissionInfo
object
DE: Abschließende Information zur Provision. EN: Complete information about commissions.
2 properties 1 required
BuildingRepaymentPlan
object
The repayment plan of the credit phase.
2 properties 2 required
OriginInfo
object
DE: Enthält die Information über Datenquelle und Daten-Identifikator aus dem externen System. EN: Contains information about Data source and data identifier in…
3 properties 2 required
KfwCallType
object
1 property 1 required
ExistingMortgageRef
object
DE: Id und Referenz zu einer bestehenden Hypothek. EN: Id and reference to the existing mortgage.
2 properties 1 required
PauseSubmissionProcessingCommand
object
command to pause processing of the submission
3 properties
KfwProgram
object
2 properties
FinancingVentureConstruction
object
DE: Information über das Finanzierungsvorhaben beim Bau einer Immobilie. EN: Information about the financing venture when building the property.
3 properties 2 required
LoanToValueRatioEntry
object
6 properties 1 required
BuyNewEstateFinancing
object
DE: Finanzierungsrelevante Information zum Kauf der Neubauimmobilie. EN: Financing-relevant information for the purchase of a newly built property.
4 properties 1 required
CommandTrigger
OrganizationUser
object
DE: Informationen über den Benutzer. EN: Information about the user.
2 properties
CommissionCalculationInfo
object
DE: Abschließende Information zur Provision. EN: Complete information about commissions.
3 properties 1 required
ApplicantRelationshipTypeKey
string
DE: Beziehungsart (nicht abschließende Aufzählung) z.B. (MARRIED=mit Ehepartner/in, REGISTEREDPARTNERSHIP=eingetragenem Lebenspartner/in, PARTNERSHIP=Lebenspar…
ShareHolding
object
DE: Anteilsquote am Unternehmen. EN: Shareholding quota of the company.
1 property 1 required
SpecialRepayment
Estate
FinancingApplicationReason
string
DE: Finanzierungsgründe (nicht abschließende Aufzählung), z.B. BUYNEW, BUYEXISTING, BUILD, REFINANCE, RENOVATE, RAISECAPITAL. EN: Open ended enum contains type…
RenovateEstateFinancing
DE: Finanzierungsrelevante Information zum Umbau / Modernisierung. EN: Financing-relevant information for the refurbishment / modernisation.
SubmissionOverviewItem
object
Holds overview information about the requested Submission. Further details will be delivered in the embedded property if specified. Please refer to Expansion s…
3 properties 2 required
FinancialStanding
CounterOfferBuildingSavingLoanCreditPhase
object
1 property 1 required
ContractInfo
object
DE: Vertragsnummer mit Referenznummer ID. EN: Contract number and reference id pair.
3 properties 3 required
OtherOccupation
object
DE: Nicht näher spezifizierte Erwerbstätigkeit. EN: Unspecified Occupation.
3 properties
Submission
object
DE: Ein Kreditantrag enthält alle relevanten Informationen für eine Kreditentscheidung. EN: A submission holds all the information in order to help the financi…
8 properties 1 required
SubmissionCounterOfferCreatedStatus
object
EN: Status containing information about counteroffer that was created
1 property 2 required
RentPeriodType
object
1 property 1 required
FinancialStandingSummary
object
5 properties
EstateAcquisitionCosts
object
DE: Kosten für den Erwerb der Immobilie. EN: Estate costs when purchasing a property.
3 properties
House
object
DE: Zusätzliche Information zu der Immobilie von Typ "HOUSE" (Haus). EN: Additional Information for the estate with the type "HOUSE".
6 properties
SuspendedAmortizationBuildingSavingProduct
object
2 properties
AlimonyExpense
object
DE: Ausgaben durch Unterhalt. EN: Expenses for alimony.
2 properties 1 required
Phone
object
3 properties 2 required
BaseSubmissionCommand
object
3 properties 1 required
CalculationContext
object
DE: Kalkulation nach Art des Darlehens. EN: A set of financing structure contexts, which are associated with this calculation (i.e Main or Nachrang component)..
1 property
HouseUnitCommerceTypeKey
string
DE: Mögliche Gewerbearten. z.B. RETAIL, MEDICALPRACTICE, etc.. EN: Open ended enum contains commerce business line , possible values are (RETAIL, MEDICALPRACTI…
EuroAmountPerSquareMeter
object
DE: Euro Betrag pro Quadratmeter. EN: Euro amount per square meter.
1 property 1 required
Debitor
object
DE: Darlehensgeber. EN: Information about loan debitor.
2 properties
ConfirmedSubmissionStatus
object
EN: Status containing information about confirming the submission
1 property 2 required
EstateAdditionalCosts
object
3 properties
PropertyRegisterOwner
SubmissionDataViolationSeverity
object
1 property 1 required
FinancialEquity
object
DE: Informationen zum Eigenkapital vor Beginn des Finanzierungsprozesses. EN: Financial equity information before the financing process.
7 properties 1 required
Handover
object
DE: Beratunsprotokoll und Empfehlung des Beraters. EN: Advisor Handover notes and recommendations.
3 properties
VariableInterestMaturity
object
DE: Information über die variable Sollzinsbindung. EN: Information about variable interest rate maturity.
1 required
LoanPartnerQueueId
object
DE: ID der loan parnter queue. EN: Loan partner queue id.
1 property 1 required
SquareMeter
object
DE: Angabe in Quadratmetern. EN: Specification in square metres.
1 property 1 required
SubmissionRejection
object
2 properties 1 required
KfwCallTypeKey
string
DE: Art der KFW-Reservierung (nicht abschließende Aufzählung), z.B. LIGHT, PLUS. EN: Open ended enum contains Kfw reservation process call type, possible value…
CollateralMortgageProperties
object
DE: Weitere Beleihungsobjekte die als Sicherheit verwendet werden. EN: Other estates to be pledged as security deposit.
1 property
ApplicantRelationshipType
object
1 property 1 required
SubmissionItem
object
Holds basic information identifying a specific submission resource.
2 properties 2 required
ModernisationType
object
1 property 1 required
CountryCode
object
DE: Ländercode nach ISO3166-1alpha-2 (https://en.wikipedia.org/wiki/ISO3166-1alpha-2). EN: Official ISO3166-1alpha-2 (https://en.wikipedia.org/wiki/ISO3166-1al…
1 property 1 required
Duration
object
DE: Gibt einen Zeitraum an. EN: Specifies a duration.
2 properties 2 required
BaseOwnEstateFinancingNeed
object
DE: Finanzierungsbedarf für die eigene Immobilie EN: Financing need for the own estate.
4 properties 1 required
LoanPartnerProcessingUnitId
object
DE: ID der Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. EN: Id of the loan partner processing unit.
1 property 1 required
LoanPartnerProcessingInfo
object
DE: Einheit des Kreditgebers, welche die Einreichung bearbeitet und aktueller (Kreditsach-)Bearbeiter. EN: Processing Unit and current processor of the loan pa…
2 properties
RevokeSubmissionCounterOfferReason
object
1 property 1 required
EstateId
object
DE: ID der Immobilie. EN: ID of the estate.
1 property 1 required
Cycle
object
DE: Wrapper für Zykluswerte EN: Wrapper for cycle values.
1 property 1 required
ApplicantIdRef
object
DE: Id und Referenz des Antragstellers. EN: Id and reference of the applicant.
2 properties
UserId
object
DE: ID des Users. EN: ID of a user.
1 property 1 required
DebtId
object
DE: ID der Verbindlichkeit. EN: ID of the associated Debt.
1 property 1 required
OtherCapitalFinancing
object
DE: Finanzierungsrelevante Information zur Kapitalbeschaffung. EN: Financing-relevant information about the raising capital need.
1 property 1 required
ResponsiblePerson
object
3 properties 2 required
HouseUnitCommerceType
object
1 property 1 required
UnArchiveSubmissionCommand
object
Remove the archived flag from a submission.
ExternalEstateId
object
DE: ID des vorhandenen Objekts im System EN: ID of existing object in the system
1 property 1 required
ApplicantId
object
1 property 1 required
ConstructionCostInvoice
object
1 property 1 required
BaseLoan
object
DE: Information zum Darlehen(-objekt). EN: Information about the financial loan.
17 properties 4 required
Furnishing
object
1 property 1 required
ExistingModernisations
object
DE: Information über die durchgeführte Modernisierungen. EN: Complete information about modernisations that were carried out.
5 properties
ClientAdvisorId
object
DE: ID des Users. EN: ID of a user.
1 property 1 required
Occupation
SavingsPlanBurden
object
5 properties
PreSubmissionCheckItem
object
Performed pre-submission check information
2 properties 1 required
BaseFinancialStanding
object
DE: Bonitätsdaten des Antragstellers welche während der Beratungsphase gesammelt wurden. - Eigenkapital - Schulden - Einkommen - Ausgaben EN: Financial Standin…
3 properties 3 required
RemainingDebtAt
object
2 properties 2 required
BasementExtensionForResidentialUse
object
1 property 1 required
FinancingVentureOtherCapitalFinancing
object
DE: Information über das Finanzierungsvorhaben bei der Kapitalbeschaffung. EN: Information about the financing venture for capital raising goal.
2 properties 2 required
BankAccount
object
DE: Kontoverbindungsdaten EN: Bank account data
6 properties 2 required
InterestRateUpdate
RejectSubmissionCounterOfferReasonKey
string
DE: offenes Enum enthält mögliche Gründe für die Ablehnung eines Gegenangebots, mögliche Werte sind (CONDITIONNOTATTRACTIVEFORCUSTOMER = Konditionen waren für…
ForeclosureSale
object
DE: Information über Zwangsversteigerung. EN: Information about foreclosure sale.
3 properties
ProductTypeKey
string
DE: Art des Zusatzprodukten. EN: Enum contains type of the additional product.
PropertyRegisterRestriction
object
DE: Lasten und Beschränkungen (Eintrag aus der zweiten Abteilung des Grundbuchblattes). EN: Loads and restrictions (entry from the second section of the land r…
4 properties
HousingExpense
object
DE: Informationen zu Wohnungsausgaben. EN: Information regarding housing expenses.
3 properties 1 required
SubmissionAwaitExternalProcessingStatus
object
EN: Status containing information about external processing
2 properties 1 required
FinancingOffer
object
DE: Information über das Finanzierungsangebot. EN: Information about the financing offer (bid).
10 properties 2 required
HouseRating
object
DE: Bewertung des Hauses (Gebäude und Grundstueck). EN: Rating of a house (building and property).
1 property
LoanPartnerDetails
object
DE: Informationen zum Kreditgeber und der Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. EN: Information about the loan partner and the processi…
3 properties 2 required
CreditLoanItem
object
Holds information regarding a specific submission credit loan. Further details will be delivered in the embedded property if specified. Please refer to Expansi…
4 properties
PredictedLoanPartnerDecisionDate
object
DE: Voraussichtliches Entscheidungsdatum des Kreditgebers. EN: Predicted decision date of the loan partner.
2 properties 1 required
RentPeriodTypeKey
string
DE: Mietdauer, z.B. befristet, unbefristet oder unvermietet. EN: Open ended enum contains rent period, possible values are (LIMITED, UNLIMITED, UNRENTED).
CompanyVendor
object
1 property 2 required
InterestMaturityType
string
DE: Art der Sollzinsbindung(nicht abschließende Aufzählung), z.B. FIXEDPERIOD, VARIABLE. EN: Open ended enum contains types of the interest maturity, possible…
RealEstatePropertyConditionKey
string
DE: Zustand des Gebäudes (nicht abschließende Aufzählung), z.B. INTOTALRENOVATIONNEED, INEXTENSIVEMODERNISATIONNEED, INRENOVATIONNEED, INMODERNISATIONNEED, WEL…
CounterOfferLoan
PhoneType
object
1 property 1 required
AssignSubmissionLoanPartnerProcessorCommand
object
assign a processor using an id
1 property 1 required
ConditionCalculation
object
DE: Information über Konditionskalkulation. EN: Information about condition calculation.
2 properties
ProcessorName
object
DE: Username, Vor- und Nachname des (Kredit-)Bearbeiters. EN: Username, first- and lastname of the loan partner processor.
3 properties 1 required
BaseInterestRateUpdate
object
1 property 1 required
SavingsPlanBurdenSpecialPayment
object
3 properties 2 required
Margin
object
2 properties 1 required
ModernisationScopeKey
string
DE: Umfang der Modernisierung (nicht abschließende Aufzählung), z.B. (COMPLETE=komplett, PARTIAL=teilweise, UNKNOWN=unbekannt). EN: Open ended enum contains sc…
LoanToValueRatioLendingBreakdown
object
2 properties 2 required
ExistingBuildingSavingPlan
object
DE: Information zur Zwischenfinanzierung in Zusammenhang mit einem bald fälligen Bestandsbausparers. EN: Information about bridging debt associated with a buil…
1 property 2 required
SubmissionCounterOfferId
object
DE: ID vom Gegenangebot. EN: Id of the counter offer.
1 property 1 required
RegularMainProduct
LoanQuotaTypeKey
string
DE: Ursprung des Wertes der Darlehensquote (nicht abschließende Aufzählung), z.B. CALCULATED, EXTERNAL. EN: Open ended enum contains loan quota values, possibl…
RefuseSignContractReasonKey
string
DE: Grund für die Ablehnung des Vertrags, mögliche Werte sind NOTARYAPPOINTMENTUNAVAILABLE=Notartermin kann nicht rechtzeitig stattfinden, OBJECTUNAVAILABLE=Ob…
ResumeSubmissionProcessingCommand
object
command to resume submission processing
1 property
RateDetailsType
string
DE: Mögliche Darlehensart (nicht abschließende Aufzählung), z.B. ANNUITY=Annuitätsdarlehen, SUSPENDEDAMORTIZATION=Tilgungsaussetzungsdarlehen. EN: Open ended e…
NeighbourhoodKey
string
DE: Umgebung (nicht abschließende Aufzählung), z.B. RESIDENTIAL=reinesWohngebiet, COMMERCIAL=ueberwiegendGewerbegebiet, MIXED=Mischgebiet, INDUSTRIAL=Industrie…
Iban
object
DE: IBAN EN: The International Bank Account Number
1 property 1 required
UtilizationKey
string
DE: Nutzung des Ojektes (nicht abschließende Aufzählung), z.B. SELFOCCUPIED, PARTLYRENTOUT, RENTOUT. EN: Open ended enum contains utilization of the property,…
CounterOfferKfwLoan
object
DE: Information zum Gegenangebot Kfw-Darlehen. EN: Information about the counter offer KFW loan.
2 properties 3 required
PaymentTime
object
1 property 1 required
SetSubmissionDataViolationsCommand
object
command to indicate submission violations
2 properties 1 required
AcceptSubmissionCounterOfferCommand
object
command to accept a counter offer.
2 properties 1 required
MainLoan
object
DE: Information zum Hauptdarlehen. EN: Information about the main loan.
3 properties 1 required
FinancingVentureBuyExisting
object
DE: Information über das Finanzierungsvorhaben für den Kauf einer bestehender Immobilie. EN: Information about the financing venture to buy an existing propert…
2 properties 2 required
HouseUnitCommercialUsage
object
2 properties
VariableIncomeBreakdown
object
DE: Details über regelmäßige Einnahmen EN: Breakdown of the periodical income.
5 properties
SuspendedAmortizationOtherProduct
object
FinancialDebt
object
DE: Informationen über (finanzielle) Schulden vor Beginn der angefragten Finanzierung. EN: Financial debts information before the financing process.
3 properties 1 required
RejectSubmissionCounterOfferReason
object
1 property 1 required
LoanDetails
object
details of the loan to be updated
5 properties 1 required
UnionInfoDBB
object
DE: Informationen zum Deutschen Beamten Bund EN: Information regarding German Civil Service Federation
1 property 1 required
FinancingApplicationStatus
object
1 property 1 required
SavingsEntry
object
The object for a single savings entry regarding the cash flow.
5 properties 4 required
StatSource
object
1 property 1 required
FinancingVentureRenovation
object
DE: Information über das Finanzierungsvorhaben beim Umbau / Modernisierung. EN: Information about the financing venture for refurbishment / modernisation.
2 properties 2 required
BaseSpecialRealEstateCharacteristics
object
DE: Spezielle Nutzung der Immobilie. EN: Special use of property.
8 properties 1 required
UnavailableEquity
object
DE: Information zur Zwischenfinanzierung in Zusammenhang mit nicht verfügbaren Eigenkapital. EN: Bridging Debt associated with unavailable equity
3 properties 2 required
BaseCounterOfferRateDetails
object
2 properties 3 required
MainProduct
FinancingOfferStatusKey
string
DE: Status des Finanzierungsangebots. EN: Financing offer status.
BaseCommandTrigger
object
2 properties 1 required
PeriodicalSavingsEntry
object
ApartmentFloorKey
string
DE: Lage des Appartments im Gebäude (nicht abschließende Aufzählung), zum Beispiel: BASEMENT=Untergeschoss, GROUNDFLOOR=Erdgeschoss, UPPERFLOOR=Obergeschoss/Er…
RegulatoryAuthority
object
DE: Die Zuständige Aufsichtsbehörde der Firma. EN: Responsible supervisory authority of the company.
4 properties
RealEstateEquityDetails
object
DE: Informationen zum Eigenkapital durch Immobilienvermögen. EN: Details about equites associated with the real estate.
1 property 1 required
Applicants
object
A wrapper type which holds the essential applicant information.
1 property 1 required
SavingsPlanBurdenSpecialPaymentPeriod
object
2 properties 2 required
HouseUtilityUnitGroupsBreakdown
object
1 property
LoanPartnerProcessorId
object
DE: ID des (Kredit-)Bearbeiters. EN: Id of the loan partner processor.
1 property 1 required
BusinessLineKey
string
DE: Branche der Tätigkeit (nicht abschließende Aufzählung). EN: Open ended enum contains values for the business line, possible values are AGRICULTURE, CARDEAL…
UpcomingPayments
object
DE: Kosten für das Tilgungssurrogat in den Folgeperioden. EN: Upcoming payments for repayment surrogate product.
3 properties
ForeignEstateFinancingNeed
BridgingFinancingMainProduct
object
DE: Information zur Zwischenfinanzierung im Annuitätendarlehen. EN: Information on the bridging financing product in the annuity product.
1 property
ApplicantRelationship
object
DE: Beziehung zwischen genau zwei für Antrag relevanten Antragstellern. Wenn dieses Objekt nicht vorhanden ist, dann ist existieren keine Beziehungen. EN: Rela…
2 properties 1 required
SuspendedRepaymentProductType
object
1 property 1 required
SpecialHouseCharacteristics
object
DE: Spezielle Nutzung des Hauses. EN: Special use of the house.
1 property
IntentId
object
DE: IntentId aus dem externen System. EN: IntentId in the external system.
1 property
SubmissionRevokedReasonType
string
DE: Mögliche Gründe für einen Widerruf des Darlehensvertrags EN: Possible reasons for revocation of the loan agreement
Expense
object
DE: Ein Untertyp von "Financial Standing", welcher alle Informationen zu den Ausgaben beinhaltet. EN: A specific financial standing type holds all information…
5 properties 1 required
MaritalStatusKey
string
DE: Familienstand des Antragstellers (nicht abschließende Aufzählung, zum Beispiel: SINGLE = LEDIG, MARRIED = VERHEIRATET, REGISTEREDPARTNERSHIP = EINGETRAGENE…
SubmissionStatusType
string
DE: Mögliche Status der Einreichung (nicht abschließende Aufzählung), z.B. (REJECTED, CONTRACTDELIVERED) EN: Open ended enum contains submission status value,…
Employment
object
DE: Informationen über das Beschäftigungsverhältnis des Antragstellers. EN: Information regarding employment data.
5 properties
RevokeSubmissionCommand
object
This command is only used for internal purposes!
2 properties 1 required
CreditPhaseBurden
object
4 properties
CounterOfferAuxiliaryLoan
object
DE: Information zum Gegenangebot Nachrangdarlehen. EN: Information about the counter offer auxiliary loan.
1 property 2 required
SpecialPropertyType
object
1 property 1 required
ConsultationItem
object
2 properties 1 required
OtherCapitalNeededLoan
object
DE: Details über das Darlehen, welches zur Kapitalbeschaffung benötigt wird. EN: Details about the loan needed for raising capital.
2 properties 1 required
PropertyRegisterMortgage
object
DE: Hyptheken, Grundschulden, Rentenschulden (Eintrag aus der dritten Abteilung des Grundbuchblattes). EN: Mortgages, land charges, annuities (entry from the t…
12 properties
Consultation
object
DE: Informationen über die Beratung und dazugehörige Empfehlungen. EN: Information about the involved parties in the consultation phase and the associated reco…
6 properties 1 required
Advisor
object
DE: Informationen über den Berater. EN: Information about the advisor.
4 properties 1 required
ClientAdvisor
object
DE: Informationen über den Endkundenberater. EN: Information about the customer sales advisor.
3 properties 1 required
InsuranceBurden
object
2 properties 1 required
PhoneReachabilityKey
string
DE: Erreichbarkeit unter dieser Telefonnumer (nicht abschließende Aufzählung, zum Beispiel: DAYTIME = tagsüber, EVENING = abends). EN: Reachable by this phone…
ApartmentFloor
object
1 property 1 required
ProcessorId
object
DE: ID des Sachearbeiters bei einem Kreditgeber. EN: Id of the loan partner processor.
1 property 1 required
CancelContractReason
object
1 property 1 required
ConditionCalculationDetails
object
DE: Information über einzelnen Darlehen innerhalb des Konditionskalkulations. EN: Information about single loan which is a part of condition calculation.
6 properties 6 required
PreInquiryStatusKey
string
DE: Status des Voranfrage. EN: Status of the preInquiry.
CancelContractSubmissionCommand
object
command to cancel a signed contract of a submission on behalf of the customer.
3 properties 2 required
RawPercentage
object
DE: Prozentsatz. EN: Percentage.
1 property 1 required
LoanPartnerProcessorName
object
DE: Username, Vor- und Nachname des (Kredit-)Bearbeiters. EN: Username, first- and lastname of the loan partner processor.
3 properties 1 required
SubmissionProcessingPausedStatus
object
EN: Status containing information about pausing the processing
4 properties 2 required
CessionClaim
object
DE: Information zur Abtretung der Grundschuld. EN: Information about the cession of the land charge.
1 property 1 required
CounterOfferAnnuityRateDetails
object
1 property
SubmissionCounterOfferRevokedStatus
object
EN: Status containing information about counteroffer that was revoked
1 property 2 required
HouseRentedUnitDetails
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

interhyp-submissions-api-openapi.yml Raw ↑

Other APIs Interhyp publishes across the network.

Interhyp commands API
Interhyp documents API
Interhyp financing-application API
Interhyp info API
Interhyp logbook API
Interhyp pre-submission-checks API
Interhyp protocol API
Where this information came from

This is an independent, third-party profile of Interhyp submissions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.