Interhyp financing-application API
provides endpoints for financing application resources not associate to a specific financing partner
OpenAPI Specification
openapi: 3.0.2
info:
title: Interhyp Submission commands financing-application API
version: 2.0.0
contact:
name: Interhyp AG (Team Provider Excellence)
email: support_submission_api@interhyp.de
license:
name: Interhyp AG
description: '### This document describes the RESTful API and resources provided by Interhyp AG.<p> The RESTful API provides access to resources associated to submission process via *URI* paths, a client application will make an HTTP request using standard HTTP methods like *GET, PUT, POST and DELETE* and parse the response in *JSON* format.<p>
### API Audience<p> The API is intended to be consumed by clients who want to integrate Interhyp submission process in their own workflow.
+ **Bank Partners**
### API design Principles <p> During API design a set of principles were taken into consideration.
+ **API First**
+ **Mobile First**
### API client <p> As an API client you should adhere to the following robustness principle
+ **Tolerant Reader** Be tolerant with unknown fields in the payload. This is required to avoid new API versions if new fields were added, i.e. ignore new fields but do not eliminate them from payload if needed for subsequent *PUT* requests
+ Be prepared to handle HTTP status codes not explicitly specified in endpoint definitions.'
servers:
- url: https://api-test.interhyp.de/submission
description: Test-Staging
- url: https://api.interhyp.de/submission
description: Production
security:
- BearerAuth: []
tags:
- name: financing-application
description: provides endpoints for financing application resources not associate to a specific financing partner
paths:
/financing-applications/{financingApplicationId}:
get:
summary: Get a exisiting financing application
description: 'Delivers information about existing financing application
'
operationId: getFinancingApplicationById
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/embed'
responses:
'200':
description: Financing application is returned
content:
application/json:
schema:
$ref: '#/components/schemas/FinancingApplication'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested financing application resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/applicant-relationships:
get:
summary: Get a list of applicant-relationships
description: 'Delivers information about the relationship of the applicants involved in this financing application.
'
operationId: getApplicantRelationshipsByFinancingApplicationId
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
responses:
'200':
description: requested applicant relationsships are returned
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicantRelationshipsQuery'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that the financing application resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/applicants:
get:
summary: Get applicants for a specific submission package.
description: Delivers detailed information for applicants associated with this submission.
operationId: getApplicantsByFinancingApplicationId
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/embed'
responses:
'200':
description: Requested applicants are returned
content:
application/json:
schema:
$ref: '#/components/schemas/Applicants'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/applicants/{applicantId}:
get:
summary: Get a specific mortgage applicant
description: Delivers detailed information for mortgage applicant by his id.
operationId: getApplicantById
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/applicant-id'
responses:
'200':
description: Requested applicant is returned
content:
application/json:
schema:
$ref: '#/components/schemas/Applicant'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested applicant resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/applicants/{applicantId}/financial-standings:
get:
summary: Get applicant financial standings
description: 'Delivers detailed information about an applicant financial standings associated with this financing application.
Including periodical income, expenses, general equity and debts'
operationId: getFinanceStandingsForApplicant
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/applicant-id'
- $ref: '#/components/parameters/financial-standing-filter'
- $ref: '#/components/parameters/embed'
responses:
'200':
description: Requested applicant financial standings are returned
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialStandings'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/consultation:
get:
summary: Get financing consultation
description: Delivers detailed information about the consultation associated with this financing application.
operationId: getConsultationByFinancingApplicationId
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
responses:
'200':
description: Requested financing consultation returned.
content:
application/json:
schema:
$ref: '#/components/schemas/Consultation'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/estates:
get:
summary: Get estates for a specific financing application.
description: Delivers detailed information for the estates associated with this financing application. Estate could have a role as an object to be financed, an equity item or a guarantee (security).
operationId: getEstatesByFinancingApplicationId
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/embed'
responses:
'200':
description: Requested estates are returned
content:
application/json:
schema:
$ref: '#/components/schemas/Estates'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested financing application resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/estates/{estateId}:
get:
summary: Get a specific estate.
description: Delivers detailed information for an estate by it's id.
operationId: getEstateById
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/estate-id'
- $ref: '#/components/parameters/financing-application-id'
responses:
'200':
description: Requested estate is returned
content:
application/json:
schema:
$ref: '#/components/schemas/Estate'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested mortgage property resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/financial-standings:
get:
summary: Get applicants financial standings
description: 'Delivers detailed information about the applicants financial standings associated with this financing application as provided by the applicant during the consultation phase.
Including periodical Income, Expenses, General Equity and Debts'
operationId: getFinanceStandingsByFinancingApplicationId
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/financial-standing-filter'
- $ref: '#/components/parameters/embed'
responses:
'200':
description: Requested financial standings associated with this financing application are returned.
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialStandings'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/financial-standings/existing-loans/{debtId}:
get:
summary: Get a specific existing loan.
description: Delivers detailed information for existing loan by it's id.
operationId: getExistingLoanById
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/debt-id'
responses:
'200':
description: Requested existing loan is returned
content:
application/json:
schema:
$ref: '#/components/schemas/ExistingLoanDebt'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested existing morgage resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/financial-standings/{financialStandingId}:
get:
summary: Get a specific financial standing
description: 'Delivers detailed information about a specific financial standing associated with this submission package.
Including periodical income, expenses, general equity and debts'
operationId: getFinanceStandingsById
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/financial-standing-id'
responses:
'200':
description: Requested financial standing is returned
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialStanding'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/households:
get:
summary: Get applicants household
description: Delivers detailed information about the applicants households associated with this financing application.
operationId: getHouseholdsByFinancingApplicationId
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
responses:
'200':
description: Requested households information are returned.
content:
application/json:
schema:
$ref: '#/components/schemas/HouseholdsQuery'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/informers:
get:
summary: Get consultation informers
description: "Delivers detailed information about the consultation informers associated with this submission.\n\nThis endpoint utilizes *Expansion* feature, where *by default* only basic information shall be returned. In order to access more full details, two options are available\n\n - follow provided links in order to navigate to submission sub-resources (i.e /v2/submissions/{submissionId}/overview)\n\n - initiate the call with request parameter `embed` set to *TRUE* (i.e /v2/submissions/{submissionId}?embed=true)\n\nPlease refer to *Expansion* section for more details."
operationId: getFinancingApplicationInformers
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/embed'
responses:
'200':
description: Requested mortgage informers are returned
content:
application/json:
schema:
$ref: '#/components/schemas/Informers'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/informers/{informerId}:
get:
summary: Get a specific mortgage informer
description: Delivers detailed information for mortgage informer by his id.
operationId: getFinancingApplicationInformerById
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
- $ref: '#/components/parameters/informer-id'
responses:
'200':
description: Requested informer is returned
content:
application/json:
schema:
$ref: '#/components/schemas/Informer'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested informer resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/offer:
get:
summary: Get financing offer
description: Delivers detailed information about the financing offer associated with this financing application.
operationId: getOfferByFinancingApplicationId
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
responses:
'200':
description: Requested financing offer is returned
content:
application/json:
schema:
$ref: '#/components/schemas/FinancingOffer'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/submissions:
get:
summary: Get financing application's submission
description: Delivers detailed information about the submission belong to specific loan partner and associated with this financing application.
operationId: getSubmissionsByFinancingApplicationId
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
responses:
'200':
description: Requested Submissions is returned
content:
application/json:
schema:
$ref: '#/components/schemas/Submissions'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
/financing-applications/{financingApplicationId}/venture:
get:
summary: Get financing venture
description: Delivers detailed information about the financing venture associated with this financing application.
operationId: getVentureByFinancingApplicationId
tags:
- financing-application
parameters:
- $ref: '#/components/parameters/financing-application-id'
responses:
'200':
description: Requested financing venture is returned
content:
application/json:
schema:
$ref: '#/components/schemas/FinancingVenture'
'400':
description: Error indicates missing or wrong request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'401':
description: Error indicates no access to the required resource.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthProblem'
'404':
description: Error indicates that a requested submission resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
components:
schemas:
EntryMarking:
type: object
description: 'Object to define entry markings like ''the end of the fixed interest rate'' or ''the amortization rate changed to''. The properties ''name'' and ''period'' are required and there can be additional key/value pairs for the specific markings like, ''rate: 3.5%'' for the value of the changed amortization rate if name is ''AMORTIZATION_RATE_CHANGED''.
'
allOf:
- $ref: '#/components/schemas/EntryPeriod'
required:
- name
properties:
name:
description: The name of the marking
$ref: '#/components/schemas/MarkingName'
rate:
description: present if type is 'AMORTIZATION_RATE_CHANGED'
$ref: '#/components/schemas/EuroAmount'
amount:
description: present if type is 'EXTRA_PAYMENT'
$ref: '#/components/schemas/EuroAmount'
AuxiliaryLoan:
description: 'DE: Information zum Nachrangdarlehen. <br/>
EN: Information about the auxiliary loan.
'
type: object
required:
- product
allOf:
- $ref: '#/components/schemas/BaseLoan'
properties:
annuityDetails:
$ref: '#/components/schemas/AnnuityDetails'
product:
$ref: '#/components/schemas/AuxProductType'
Contact:
type: object
properties:
phoneNumbers:
type: array
items:
$ref: '#/components/schemas/Phone'
email:
type: string
description: 'DE: E-Mail des Antragstellers <br/> EN: E-Mail of the customer
'
example: primary@example.com
HouseUtilityOwnUnitGroup:
type: object
allOf:
- $ref: '#/components/schemas/BaseHouseUtilityUnitGroup'
AlimonyInfo:
type: object
required:
- alimony
description: 'DE: Informationen über Unterhaltseinkünfte. <br/> EN: Information regarding alimony income.
'
properties:
alimony:
$ref: '#/components/schemas/PeriodicalEuroAmount'
maritalPart:
description: 'DE: Davon: aus Ehegattenunterhalt. <br/>
EN: Of which: from spousal aliment.
'
$ref: '#/components/schemas/PeriodicalEuroAmount'
childPart:
description: 'DE: Davon: aus Kindesunterhalt. <br/>
EN: Of which: from child support.
'
$ref: '#/components/schemas/PeriodicalEuroAmount'
PersonName:
type: object
required:
- gender
- firstName
- lastName
properties:
gender:
type: string
description: 'DE: Geschlecht der Person (nicht abschließende Aufzählung), z. B. M=männlich, F=weiblich, D=divers, UNSPECIFIED. <br/> EN: Open ended enum contains gender of the person, possible values are M=male, F=female, D=diverse, UNSPECIFIED.
'
x-extensible-enum:
- M
- F
- D
- UNSPECIFIED
title:
$ref: '#/components/schemas/Title'
firstName:
type: string
description: 'DE: Vorname der Person. <br/> EN: First name of the person.
'
lastName:
type: string
description: 'DE: Nachname der Person. <br/> EN: Last name of the person.
'
maidenName:
type: string
description: 'DE: Geburtsname der Person. <br/> EN: Maiden name of the person.
'
CalculationType:
type: string
description: 'DE: Kalkulationstyp (nicht abschließende Aufzählung), z.B. HOUSEHOLD=Haushaltsrechnung, CONDITION=Konditionskalkulation, LENDING_VALUE=Beleihungswert-Kalkulation <br/> EN: Calculation type - open ended enum contains property type details, possible values are HOUSEHOLD, CONDITI
# --- truncated at 32 KB (317 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/interhyp/refs/heads/main/openapi/interhyp-financing-application-api-openapi.yml