Interhyp logbook API
provides endpoints to access submission logbook
Interhyp logbook API is one of 8 APIs that Interhyp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include logbook. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 1 operation across 1 path, and defines 189 schemas. It is described by OpenAPI 3.0.2, at version 2.0.0.
Requests are made against 2 base URLs: https://api-test.interhyp.de/submission, https://api.interhyp.de/submission.
1 operations
1 paths
189 schemas
1 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Interhyp logbook API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
logbook 1
provides endpoints to access submission logbook
GET
/submissions/{submissionId}/logbook
Get submission logbook entries
Schemas 189
The contract defines 189 schemas that model the data the API accepts and returns. The most detailed are BaseLoan (17 properties), SuspendedAmortizationDetails (13 properties), BuildingSavingPlan (11 properties), SubmissionAdditionalProduct (10 properties). Each schema is shown below with its type and property counts.
DefaultLogbookEntry
SavingsPlanTimeline
object
3 properties
AuxiliaryLoan
object
DE: Information zum Nachrangdarlehen. EN: Information about the auxiliary loan.
2 properties
1 required
UploadedDocumentTypeKey
string
Contact
object
2 properties
PersonName
object
5 properties
3 required
InterestMaturity
AssignProcessorLogbookEntry
object
DE: Ein Logbucheintrag mit Informationen zu dem neu zugewiesenen Bearbeiter. EN: A logbook entry holds information about assigning a loan partner processor to…
1 property
AcceptedCounterOfferLogbookEntryDetails
object
Accepted counter offer submission logbook entry details
1 property
1 required
RefuseSignContractReason
object
1 property
1 required
SuspendedAmortizationDetails
object
DE: Information zum Tilgungssurrogat. EN: Information about the repayment surrogate.
13 properties
1 required
Title
object
1 property
1 required
Phone
object
3 properties
2 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
LoanId
object
DE: ID des Darlehens. EN: Loan identifier.
1 property
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
RegularPayment
object
DE: Information über den regulären Zahlungen. EN: Information about regular payment.
4 properties
PauseReason
object
1 property
1 required
MainLoanAdditionalInfo
object
DE: Zustzäliche Information zum Hauptdarlehen. EN: Additional informations for main loan.
2 properties
CreditPhaseTimeline
object
3 properties
SubmissionStatusChangedLogbookEntry
object
1 property
BaseSpecialRepayment
object
DE: Information zur Sondertilgung. EN: Special repayment information.
1 property
1 required
PhoneTypeKey
string
DE: Art der Telefonnummer (nicht abschließende Aufzählung, zum Beispiel: MOBILE = Mobilfunknummer, LANDLINE = Festnetznummer, UNSPECIFIED = nicht angegeben, MO…
LogbookEntryType
string
DE: Art des Logbookentry (nicht abschließende Aufzählung), z.B. (SUBMISSIONCREATED, SUBMISSIONEDITED, DECISIONDATEUPDATED, UPLOADEDDOCUMENT, STATUS). EN: open…
DefaultSubmissionStatusChangedLogbookEntryDetails
RevokeSubmissionCounterOfferReasonKey
string
DE: Grund für den Entzug, mögliche Werte sind COUNTEROFFEREXPIRED=Gegenangebot kann nicht mehr aufrechterhalten werden, READJUSTCOUNTEROFFER=Gegenangebot soll…
PercentageSpecialRepayment
object
DE: Sondertilgung in Prozent pro Periode. EN: Special repayment presented as percent per period.
2 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
SavingsPlanBurdenSpecialPayment
object
3 properties
2 required
PeriodicalPercentage
object
DE: Periodischer Prozentsatz als double. EN: Periodical percentage as double.
2 properties
2 required
EuroAmount
object
DE: Euro Betrag as double. EN: Euro amount as double
1 property
1 required
OAuthProblem
object
Error while Authentication
2 properties
2 required
InterestRateUpdate
DecisionDateLogbookEntry
object
DE: Ein Logbucheintrag mit Informationen zu dem geänderten Entscheidungsdatum. EN: A logbook entry holds information about updating submission decision date.
1 property
SubmissionAdditionalProductsUpdatedLogbookEntryDetails
object
2 properties
BaseLogbookEntry
object
DE: Informationen zu einem Logbucheintrag. EN: Holds information about a logbook entry.
5 properties
2 required
ResourceRef
object
1 property
1 required
ProductTypeKey
string
DE: Art des Zusatzprodukten. EN: Enum contains type of the additional product.
DebtId
object
DE: ID der Verbindlichkeit. EN: ID of the associated Debt.
1 property
1 required
OpenPropertySale
object
DE: Information zur Zwischenfinanzierung in Zusammenhang mit einem Immobilienverkauf. EN: Information about bridging debt associated with property sale.
2 properties
AnnuityDetails
object
DE: Detaillierte Information über das Annuitätsdarlehen. EN: Detailed information about periodic loan.
2 properties
1 required
ExternalProcessingReason
string
EN: Open ended enum contains possible reasons for external processing (EXTERNALEXPERTASSESSMENT, INTERNALEXPERTASSESSMENT, DECISIONINTERNALUNIT, CONTRACTCREATI…
RejectedCounterOfferLogbookEntryDetails
object
2 properties
1 required
KfwProgram
object
2 properties
ContractCanceledStatusLogbookEntryDetails
object
2 properties
CreditPhaseBurden
object
4 properties
CreditPhasePayout
object
2 properties
RejectReason
object
1 property
1 required
ApplicantId
object
1 property
1 required
LoanPartnerQueueId
object
DE: ID der loan parnter queue. EN: Loan partner queue id.
1 property
1 required
LogbookEntryId
object
1 property
TextSpecialRepayment
object
DE: Sondertilgung in Textform. EN: Special repayment presented as text.
1 property
1 required
AuxProductType
object
1 property
1 required
LoanPartnerQueue
object
DE: Informationen zur Kredigeber Warteschlange. EN: Information about loan partner queue.
3 properties
1 required
SubmissionRevokedReason
object
1 property
1 required
AdditionalInfo
object
DE: Zusätzliche Information als Schlüssel-Wert Paar. EN: Additional Information as key-value pairs.
2 properties
CreditLoanId
object
DE: Id der Finanzierungsstruktur. EN: Credit Loan identifier.
1 property
1 required
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…
SavingsPlanInterest
object
2 properties
HomePurchaseSavingProviderKey
string
Home purchase saving plan provider (BHWDISPO - BHW, DEUTDEFF - Deutsche Bank, ALTEDEFA - Alte Leipziger, LBS - LBS, BSWLDE - Wüstenrot, STARTBS - start:bauspar…
ApplicantIdRef
object
DE: Id und Referenz des Antragstellers. EN: Id and reference of the applicant.
2 properties
SubmissionLogbookEntry
SpecialRepayment
KfwCallType
object
1 property
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…
BaseLoan
object
DE: Information zum Darlehen(-objekt). EN: Information about the financial loan.
17 properties
4 required
MainLoan
object
DE: Information zum Hauptdarlehen. EN: Information about the main loan.
3 properties
1 required
SavingsPlanFees
object
3 properties
SubmissionStatusChangedLogbookEntryDetails
BridgingFinancingMainProduct
object
DE: Information zur Zwischenfinanzierung im Annuitätendarlehen. EN: Information on the bridging financing product in the annuity product.
1 property
ISODateTime
string
DE: Datum, Syntax nach RFC 3339 EN: Date according to RFC 3339
RejectSubmissionStatusChangedLogbookEntryDetails
object
2 properties
SubmissionCounterOffer
object
4 properties
AnnuityInterestRateUpdate
object
details of annuity interest rate update
2 properties
Percentage
object
DE: Prozentsatz als double. EN: Percentage as double.
1 property
1 required
BaseInterestRateUpdate
object
1 property
1 required
Cycle
object
DE: Wrapper für Zykluswerte EN: Wrapper for cycle values.
1 property
1 required
VariableInterestMaturity
object
DE: Information über die variable Sollzinsbindung. EN: Information about variable interest rate maturity.
1 required
MainProductType
string
DE: Produkttyp des Darlehens (nicht abschließende Aufzählung), z.B. (ANNUITAET=Annuitätendarlehen, WRIESTER=Wohnriesterdarlehen, ZWIFI=Zwischenfinanzierung, FL…
LoanPartnerProcessingUnitName
object
DE: Bezeichnung / Name der Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. EN: Name of the loan partner processing unit.
1 property
SubmissionAdditionalProductsUpdatedLogbookEntry
object
1 property
CreatedCounterOfferLogbookEntryDetails
object
2 properties
SuspendedAmortizationCombinedProduct
ClosedPropertySale
DE: Information zur Zwischenfinanzierung in Zusammenhang mit einem abgeschlossenen Immobilienverkauf. EN: Bridging debt associated with a closed property sale.
UserData
object
4 properties
LoanPartnerProcessingUnitChangedLogbookEntry
object
2 properties
2 required
ContractInfo
object
DE: Vertragsnummer mit Referenznummer ID. EN: Contract number and reference id pair.
3 properties
3 required
ContractInfoLoanType
string
DE: Type des Loans dessen Vertragsnummer aktualisiert werden soll. EN: Type of loan where the contract number should be updated.
ExtendedContractInfo
object
DE: Vertragsnummer mit Referenznummer ID. EN: Contract number and reference id pair with additional loan details.
4 properties
3 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…
Company
object
DE: Informationen zu einem Unternehmen. EN: Information of a company.
2 properties
1 required
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
CompanyName
object
1 property
BaseSuspendedAmortizationCombinedProduct
object
1 property
1 required
UploadedDocumentType
object
1 property
1 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…
SubmissionDataViolationSeverityKey
string
SubmissionDataViolationsLogbookEntry
object
1 property
PhoneReachability
object
1 property
1 required
Loan
PauseReasonKey
string
BridgingLoanDetails
ContactAdvisorUpdatedLogbookEntry
object
1 property
CreditLoan
object
DE: Informationen zur Finanzierungsstruktur. EN: A Credit Loan represents specific financing structure component.
3 properties
UpcomingPayments
object
DE: Kosten für das Tilgungssurrogat in den Folgeperioden. EN: Upcoming payments for repayment surrogate product.
3 properties
CancelContractReason
object
1 property
1 required
EstateId
object
DE: ID der Immobilie. EN: ID of the estate.
1 property
1 required
SubmissionLoanPartnerDocumentLogbookEntry
object
3 properties
1 required
RFC7807Problem
object
DE: Angaben zum zurueckgegebenen Fehler. EN: Holds information on the returned error.
8 properties
5 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…
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…
SuspendedRepaymentProductType
object
1 property
1 required
CommissionInfo
object
DE: Abschließende Information zur Provision. EN: Complete information about commissions.
2 properties
1 required
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
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
ProcessingUnit
object
DE: Informationen zur Einheit des Kreditgebers, welche die Einreichung bearbeitet. EN: Id of the loan partner processing unit.
2 properties
1 required
ContractSignedStatusLogbookEntryDetails
object
2 properties
ExternalProcessing
object
EN: Information regarding the external processing
3 properties
1 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…
RevokeSubmissionCounterOfferReason
object
1 property
1 required
KfwLoanAdditionalInfo
object
DE: Zustzäliche Information zum KFW Darlehen. EN: Additional informations for kfw loan.
1 property
MainProduct
RateDetails
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…
EstateRef
object
DE: Id und Referenz zu der Immobilie. EN: Id and Reference to the estate.
2 properties
1 required
SubmissionAdditionalProduct
object
a specific submission additional product
10 properties
3 required
SubmissionProcessingPausedStatusLogbookEntryDetails
object
2 properties
CreditPhaseInterest
object
2 properties
BaseMainProduct
object
DE: Information zum Hauptdarlehensprodukt. EN: Main loan product information.
2 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
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
Duration
object
DE: Gibt einen Zeitraum an. EN: Specifies a duration.
2 properties
2 required
SubmissionCounterOfferId
object
DE: ID vom Gegenangebot. EN: Id of the counter offer.
1 property
1 required
KfwReservationInfo
object
DE: Zusätzliche Information zur KFW-Darlehensreservierung. EN: Additional Information about the Kfw Loan reservations
4 properties
BuildingSavingPlan
object
DE: Information zum Bauspardarlehen. EN: Information about the building saving loan.
11 properties
RefuseSignContractReasonKey
string
DE: Grund für die Ablehnung des Vertrags, mögliche Werte sind NOTARYAPPOINTMENTUNAVAILABLE=Notartermin kann nicht rechtzeitig stattfinden, OBJECTUNAVAILABLE=Ob…
ExternalProcessingAwaitedLogbookEntryDetails
object
1 property
SavingsPlanBurdenSpecialPaymentPeriod
object
2 properties
2 required
BaseBridgingLoanDetails
object
DE: Information zur Zwischenfinanzierung. EN: Details about bridging loan.
3 properties
2 required
PeriodicalEuroAmount
object
DE: Euro Betrag in einem bestimmten Zeitraum. EN: Euro amount for a specific period.
2 properties
2 required
InterestRate
object
DE: Information über den Zins. EN: Information about the interest rate.
2 properties
KfwPromotionLoan
object
DE: Information zum Kfw-Darlehen. EN: Information about the KFW promotion loan.
4 properties
ContractSignRefusedStatusLogbookEntryDetails
object
2 properties
1 required
BaseSubmissionStatusChangedLogbookEntryDetails
object
Change submission logbook entry details
1 property
1 required
LoanDetails
object
details of the loan to be updated
5 properties
1 required
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…
SavingsPlanBurden
object
5 properties
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…
DocumentLogbookEntry
object
DE: Ein Logbucheintrag mit Informationen zu einem hochgeladenen Einreichungsdokument. EN: A logbook entry holds information about uploading submission document.
1 property
ISODate
string
DE: Datum, Syntax nach RFC 3339 EN: Date according to RFC 3339
PayoutInfo
object
DE: Information zur Auszahlung des Darlehens. EN: Loan payout information.
3 properties
CounterOfferRevokedLogbookEntry
object
1 property
PhoneType
object
1 property
1 required
CreditPhase
object
The credit phase object (Darlehensphase).
8 properties
SavingPlanTariff
object
6 properties
3 required
UserId
object
DE: ID des Users. EN: ID of a user.
1 property
1 required
RevokedSubmissionLogbookEntry
object
1 property
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…
RejectReasonKey
string
CompanyId
object
DE: ID des Unternehmes. EN: ID of the company.
1 property
1 required
RegularMainProduct
Handover
object
DE: Beratunsprotokoll und Empfehlung des Beraters. EN: Advisor Handover notes and recommendations.
3 properties
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…
ProductType
object
1 property
1 required
RateDetailsType
string
DE: Mögliche Darlehensart (nicht abschließende Aufzählung), z.B. ANNUITY=Annuitätsdarlehen, SUSPENDEDAMORTIZATION=Tilgungsaussetzungsdarlehen. EN: Open ended e…
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…
BaseRateDetails
object
4 properties
1 required
RevokedSubmissionLogbookEntryDetails
object
2 properties
Violation
object
DE: Ein Verstoss gegen die Schnittstellenspezifikation. EN: A violation against the API schema.
2 properties
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
PaymentTime
object
1 property
1 required
SubmissionLogbook
object
DE: Enthält alle Logbucheinträge. EN: Holds submission logbook entries.
1 property
SubmissionDataViolationSeverity
object
1 property
1 required
SuspendedAmortizationOtherProduct
object
SuspendedAmortizationBuildingSavingProduct
object
2 properties
BuildingSavingPlanInterestRateUpdate
object
details of building saving plan interest rate update
2 properties
CancelContractReasonKey
string
DE: Grund für die Vertragskündigung, mögliche Werte sind NOTARYAPPOINTMENTUNAVAILABLE=Notartermin kann nicht rechtzeitig stattfinden, OBJECTUNAVAILABLE=Objekt…
LoanContractNumberUpdatedLogbookEntry
object
1 property
SubmissionDataViolation
object
a specific submission violation
4 properties
1 required
HomePurchaseSavingProvider
object
1 property
1 required
ExternalProcessingDetail
object
1 property
1 required
SavingsPhase
object
Sparphase
6 properties
RevokedCounterOfferLogbookEntryDetails
object
2 properties
2 required
BaseInterestMaturity
object
1 property
1 required
RejectSubmissionCounterOfferReason
object
1 property
1 required
SubmissionStatusChangedLogbookEntryDetailsType
string
DE: offenes Enum enthält mögliche Details zum Status der Einreichung von Logbucheinträgen geändert EN: open ended enum contains possible logbook entry submissi…
SubmissionProcessingResumedStatusLogbookEntryDetails
object
1 property
DocumentId
object
DE: ID vom Dokument. EN: Id of the document.
1 property
1 required
ContractDeliveredStatusLogbookEntryDetails
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Interhyp 7
Other APIs Interhyp publishes across the network.
Interhyp commands API
Interhyp documents API
Interhyp financing-application API
Interhyp info API
Interhyp pre-submission-checks API
Interhyp protocol API
Interhyp submissions API
#logbook