Digitaler Finanzierungsantrag
The BDK Digitaler Finanzierungsantrag enables the creation of financing applications for end customers. In addition to data forms, it includes a credit check, video identification incl. e-signing and the option to upload supporting documents.
API Documentation
Swagger API DocumentationDraft
What is a draft
A draft means a prepared order in Digitaler Finanzierungsantrag, which includes already all relevant financing parameters, so that they can't be manipulated anymore.
Use Digitaler Finanzierungsantrag with Kundenkalkulator
If Digitaler Finanzierungsantrag is used in combination with BDK Kundenkalkulator everything works automatically and the order draft is created by Kundenkalkulator.
Before Kundenkalkulator redirects the user to Digitaler Finanzierungsantrag, an order draft is created with all relevant financing parameters. This step is necessary for security reasons.
Use Digitaler Finanzierungsantrag without Kundenkalkulator
If Digitaler Finanzierungsantrag should be used without Kundenkalkulator, you must create an order draft manually before redirecting to FAO.
Step 1: Create a calculation in Calculation Financing Service (CFS)
Before you can create an order draft in FAO, you have to create a calculation via Calculation Financing Service (CFS).
For accessing Calculation Financing Service (CFS), you have to be authenticated. Please read here for further details.
A calculation can be created by sending a POST request to the /v2/monthlyInstallment
endpoint of CFS API.
Important: The request must be sent with attribute persistCalculation: true
. A calculation created
in this way is valid for 14 days.
As return value the CFS API sends the calculationId
attribute,
which is necessary in the following for creating a draft.
Step 2: Creating a draft in Digitaler Finanzierungsantrag
A draft can be created by sending a POST request to /api/v1/draft
endpoint of FAO API
As return value the FAO API sends the orderCreationUrl
attribute,
which is the URL to access the order in FAO.
Information:
The FAO API Documentation does not describe all necessary attributes
to create a draft. The contractor
element needs some more attributes which are described in the
example below.
Step 3: Redirect to FAO
Please use the orderCreationUrl
to redirect the user to FAO.
Structure of the contractor
element
{
"type": "PRIVATE_CONTRACTOR",
"person": {
"salutation": "MR", // one of: MR, MRS
"nationality": "DE",
"firstName": "Max",
"lastName": "Mustermann",
"birthplace": "Berlin",
"birthDate": "2015-03-28", // Year-Month-Day
"maritalStatus": "SINGLE", // one of: SINGLE, MARRIED, DIVORCED, WIDOWED, LIVING_APART
"mobileNumber": "+494012345678",
"phoneNumber": "+494012345678",
"email": "max.mustermann@example.org",
"income": 1234.00,
"outgoings": 1234.00,
"installments": 1234.00,
"insolvencyProceedings": false,
"negativeCreditReports": false,
"smallBusiness": false,
"vehicleUsedForBusiness": false,
"address": {
"street": "Musterstraße",
"streetNumber": "123A",
"zipcode": "12345",
"city": "Berlin",
"country": "DE"
},
"identCard": {
"number": "IDDwwwwNNNNNn",
"placeOfIssue": "Blacksburg",
"dateOfIssue": "2015-03-28", // Year-Month-Day
"validUntil": "2015-03-28" // Year-Month-Day
},
"bankAccount": {
"iban": "DE89370400440532013000",
"owner": "Max Mustermann"
},
"job": {
"jobGroup": "WORKER", // one of: STAFFER, CIVIL_SERVICE_EMPLOYEE, WORKER, APPRENTICE, CIVIL_SERVANT, PROFESSIONAL_SOLDIER, FACTORY_EMPLOYEE, SKILLED_LABOUR, FREELANCER, BUILDING_WORKER, WORKMAN, HOUSEWIFE_HOUSE_HUSBAND, UNSKILLED_LABOUR, CLERK, PENSIONER, ANNUITANT, SELF_EMPLOYED, STUDENT, SELLER, CONSCRIPT, REGULAR_SOLDIER, CIVILIAN_SERVICE
"employment": "UNLIMITED", // one of: UNLIMITED, FIXED_TERM
"employedSince": "2015-03-28" // Year-Month-Day
},
"privateHousehold": {
"numberOfPersonsInHousehold": 1,
"numberOfChildren": 0,
"residence": "RENTAL_FLAT", // one of: PARENTS, RENTAL_HOUSE, RENTAL_FLAT, PROPRIETARY_HOUSE, PROPRIETARY_FLAT
"residentSince": "2015-03-28" // Year-Month-Day
}
}
}