![](\"https://instabank.no/wp-content/uploads/2020/11/Instabank-Logo-1.svg\"){kind=logo}
\n\nThis documentation describes Instabank's lending agent API for Germany. Below you will find the specifications for creating loan applications for the products that Instabank offers in Germany.
\nIf you're looking for the documentation for Norway you can find it here.
\nIf you're looking for the documentation for Sweden you can find it here.
\nIf you're looking for the documentation for Finland you can find it here.
\nThe documentation is provided by the Postman service. The Postman service is a commonly used service to develop, test and use modern APIs.
\nYou can start using this API in Postman by clicking the Run in Postman button, on the top right.
It's possible to generate starting snippets in most modern development languages, by selecting your favourite language in the 'LANGUAGE' drop down on the top left.
\nWe recommend generating request/response classes by copy-pasting the JSON examples into your favourite A.I tool, and prompting the A.I tool to generate the classes in your favourite development language, with or without comments.
\nAll requests documented in this documentation contain working test data, and can be executed towards the Test environment without any changes.
All fields are named to be self explanatory. However some fields have additional comments directly in the JSON examples.
\nAll fields in request examples are mandatory. Should you not have data available to populate a specific field, please contact Instabank for clarifications.
\nDebt information should be supplied in each customer's total share, of the specific type of debt.
\nIncome should be provided as the total gross income for the customer.
\nEnumeration fields are commented with all available enumerations in the request examples.
\nAll products that can have a co-buyer/customer, have request examples with co-buyer. Notice that co-buyer is not mandatory.
\nIf the application is for refinancing of existing debt, the total amount to refinance should be specified in the RefinanceAmount field. The 'RefinanceAmount' field is not mandatory.
The response examples will contain more fields than documented, but these fields are not relevant. Contact Instabank for information about undocumented fields
\nAn application is created with a Create method.
If the applicant chooses to accepted an approved application, the application is set as accepted with the SetAccepted method
When the application is set as accepted, an automatic communication (SMS and/or e-mail) with a link to Instabank’s direct channel, will be sent to the application by Instabank.
\nThe onboarding is then completed by the customer, in Instabank’s direct channel.
\nAny status changes to the application is continuously pushed back, if a push-back-service is agreed upon with Instabank.
\nIf no push-back-service is in place, the integrating part is responsible for getting status/application changes using the Get method.
Get method is setup to run on an interval, the interval should never be shorter than 5 minutes per application.As described in The flow chapter, the application has to be set as accepted by the applicant, before Instabank will start processing the application. This flow is the standard flow. Most lending agents present multiple offers from multiple banks to their customers. The customer then has to choose one of the offers. Setting the application as accepted, is this action of choosing Instabank's offer.
However, if you do not offer multiple offers for your customers, you can set the application as accepted in the Create method, by setting the DoSetAccepted field to true.
Use the URL presented in the Application.Applicant.SigningUrl for forwarding the customer to Instabank, for completion of the application.
Application.CoApplicants[].SigningUrl for co-buyers.
Available product are documented as separate Create methods below. The product is specified in the Product.Code field.
Contact Instabank for the specific terms per product.
\nCommunication between Instabank and the agent is done based on a common reference.
\nThe reference field is named Application.ExternalReference and can be set by the agent.
If this field is used, the reference has to be unique per application.
\nIf the field is not used, a GUID will automatically be generated.
\nAny status changes to the application is continuously pushed back, if a push-back-service is agreed upon with Instabank.
\nIf no push-back-service is in place, the integrating part is responsible for getting status/application changes using the Get method.
If the Get method is setup to run on an interval, the interval should never be shorter than 5 minutes per application.
The API uses basic authentication.
\nA user name and password will be provided.
\nThe user name will be the same for all environments.
\nThe password will be different in all environments.
\nThe only mandatory fields are Application.Applicant.FirstName/LastName/BirthDate/Email/MobilePhoneNumber, Application.Product.Code and Application.Calculaton.Amount.
\nAll other fields should only be filled if you have a value for the field. Do not default fields you do not have values for, set them null or do not inlcude them in the request. This means; do not set string fields to empty string, do not set number fields to 0, do not set boolean values to false, or any other value, if you do not have an actual value for the field.
\nSee the documented example responses for fields in the response. Notice that it's only the relevant fields that are in the documented examples. The response will contain more fields than documented, but these fields are not relevant. Contact Instabank for information about undocumented fields.
\nEnumeration fields are commented with all available enumerations in the request examples.
\nThere are no error scenarios that needs specific handling. All errors will generate a HTTP status indicating and error.
\nThe response on error will contain the following fields:
\nMessage - Describing the error.
Code - Uniquely identifying the error.
RequestId - Uniquely identifying the request.
{\n \"Message\": \"An error occurred\",\n \"Code\": 10,\n \"RequstId\": \"5edf8ed9-ebb1-41a8-bc84-07c8910f6d68\"\n}\n\nPlease contact Instabank if you experience repeated errors.
\nAll products that can have a co-buyer/customer, have request examples with co-buyer. Notice that co-buyer is not mandatory.
\nCustomer and co-buyer share the same fields in the request and response.
\nDebt information should be supplied in each customer's total share, of the specific type of debt.
\nI.E if there's two customers, and they have a shared mortgage loan of 200 000. The mortgage loan share for each applicant is 100 000.
\nIncome should be provided as the total net income for the customer.
\nIf the application is for refinancing of existing debt, the total amount to refinance should be specified in the RefinanceAmount field. The 'RefinanceAmount' field is not mandatory.
There is a production environment and a test environment.
\nAll testing should be done in the test environment.
\nThe test data provided in this documentation will only work in the test environment.
\nYou will be provided a different password for each environment, the user name is the same in all environments.
\nThe API base URL will be different for each environment.
\nProduction: https://netbank.instabank.de
\nThe only difference in the URL between production and test is the addition of pp in test.
Between the countries, the top/country part of the domain/URL will change. - .no, .fi, .se, .de
Updating an application is not available. Contact Instabank if you have specific needs related to updating.
\nCancelling an application is restricted. Contact Instabank if you have specific needs related to cancelling.
\ninstasupport@instabank.no - General support
\nerik.aune@instabank.no - API responsible
\ndaniel.ramstad@instabank.no - API responsible
\nRequest for creating an application for a credit card.
\n","urlObject":{"protocol":"https","path":["public","api","application","create"],"host":["netbankpp","instabank","de"],"query":[],"variable":[]}},"response":[{"id":"6ac32e1e-5dd9-4d6c-8280-95684fd80bef","name":"Create credit card","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Application\": {\r\n \"Product\": {\r\n \"Code\": 600\r\n },\r\n \"Applicant\": {\r\n \"FirstName\": \"Test\",\r\n \"LastName\": \"Person\",\r\n \"Address\": \"Street 24\",\r\n \"ZipCode\": \"01574\",\r\n \"City\": \"Berlin\",\r\n \"BirthDate\": \"1980-01-23\",\r\n \"EMail\": \"customer@instabank.com\",\r\n \"MobilePhoneNumber\": \"000000000\",\r\n /*\r\n Married = 1,\r\n Cohabiting = 2,\r\n Divorced = 3,\r\n Single = 4 \r\n */\r\n \"MaritalStatus\": 1,\r\n /*\r\n PermanentlyEmployed = 1,\r\n TemporarilyEmployed = 2,\r\n SelfEmployed = 3,\r\n Unemployed = 4,\r\n SicknessAllowance = 5,\r\n DisabilityPension = 6,\r\n Retired = 7,\r\n Student = 8,\r\n Other = 9\r\n */\r\n \"EmploymentStatus\": 1,\r\n \"OwnsHouse\": true,\r\n /*\r\n Monthly housing cost\r\n */\r\n \"MonthlyHousingCost\": 0,\r\n /*\r\n Is German citizen or has German ID/passport\r\n */\r\n \"IsCitizen\": true,\r\n \"MonthlyIncome\": 800,\r\n /*\r\n Monthly cost for all debt\r\n */\r\n \"MonthlyDebtCost\": 500,\r\n /*\r\n PSD2 data as a base64 string\r\n */\r\n \"Psd2DataAsBase64\": \"\"\r\n }\r\n },\r\n /*\r\n Set to 'true' if this application is not sent to any other banks\r\n */\r\n \"DoSetAccepted\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://netbankpp.instabank.de/public/api/application/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Access-Control-Allow-Origin","value":"null"},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"},{"key":"X-Robots-Tag","value":"noindex, nofollow, noarchive"},{"key":"Date","value":"Wed, 24 Jul 2024 12:40:27 GMT"},{"key":"Content-Length","value":"1221"}],"cookie":[],"responseTime":null,"body":"{\n \"Application\": {\n \"Offer\": {\n \"Interest\": 12.5,\n \"EffectiveInterest\": 15.38256,\n \"MonthlyAmountTotal\": 3413.73,\n \"MonthlyAmount\": 3368.73,\n \"InvoiceFee\": 45,\n \"MonthlyFee\": 45,\n \"AdministrationFee\": 90,\n \"FeesTotal\": 1035,\n \"DocumentFee\": 0,\n \"Amount\": 100\n },\n \"Applicant\": {\n /*\n When redirecting the customer to Instabank, use this URL\n */\n \"SigningUrl\": \"https://netbankpp.instabank.de/#/loan/new?reference=57e942a5-4269-436f-8b34-5ab9ae371eb7\",\n /*\n True, if PSD2 is required for the approval\n */\n \"IsPsd2Required\": false\n },\n /*\n • Cancelled - The application is cancelled.\n • New - The application is in control, and is awaiting further manual handling.\n • Approved - The application has been approved, but is awaiting further handling.\n • Control - The application is in control, and is awaiting further manual handling.\n • Rejected - The application is rejected, and can be manually cancelled or will be automatically cancelled after a set amount of days.\n • DocumentsSent - The application has been approved, but is awaiting further handling.\n • DocumentsComplete - The application has been approved and documents are received, but the application is awaiting further internal handling/verification.\n • Complete - The application has been approved, and the loan is paid out.\n */\n \"Status\": \"Approved\",\n /*\n The common reference for the application. \n If specified in the request, it will be the same as in the request. If not, it's a generated GUID.\n */\n \"ExternalReference\": \"57e942a5-4269-436f-8b34-5ab9ae371eb7\",\n /*\n Instabank's internal reference for the application.\n */\n \"Sequence\": 3220114\n }\n}"}],"_postman_id":"dfff6f9c-8c5b-4dd0-a067-f021afa622e6"},{"name":"Set accepted","id":"0368d680-8627-4d16-87a9-75ddfb7f11b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Request for setting an application as accepted.
\nAs described in The flow chapter, the application has to be set as accepted by the applicant, before Instabank will start processing the application. This flow is the standard flow. Most lending agents present multiple offers from multiple banks to their customers. The customer then has to choose one of the offers. Setting the application as accepted, is this action of choosing Instabank's offer.
However, if you do not offer multiple offers for your customers, you can set the application as accepted in the Create method, by setting the DoSetAccepted field to true.
Request for getting an application.
\nIf the this method is setup to run on an interval, the interval should never be shorter than 5 minutes per application.
\n","urlObject":{"protocol":"https","path":["public","api","application","get"],"host":["netbankpp","instabank","de"],"query":[],"variable":[]}},"response":[{"id":"79d84c9c-4161-4932-be63-743aabd11a34","name":"Get","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Application\": {\r\n \"ExternalReference\": \"57e942a5-4269-436f-8b34-5ab9ae371eb7\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://netbankpp.instabank.de/public/api/application/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Access-Control-Allow-Origin","value":"null"},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"},{"key":"X-Robots-Tag","value":"noindex, nofollow, noarchive"},{"key":"Date","value":"Wed, 24 Jul 2024 12:40:27 GMT"},{"key":"Content-Length","value":"1221"}],"cookie":[],"responseTime":null,"body":"{\n \"Application\": {\n \"Offer\": {\n \"Interest\": 12.5,\n \"EffectiveInterest\": 15.38256,\n \"MonthlyAmountTotal\": 3413.73,\n \"MonthlyAmount\": 3368.73,\n \"InvoiceFee\": 45,\n \"MonthlyFee\": 45,\n \"AdministrationFee\": 900,\n \"FeesTotal\": 1035,\n \"DocumentFee\": 0,\n \"Amount\": 100000\n },\n \"Applicant\": {\n /*\n When redirecting the customer to Instabank, use this URL\n */\n \"SigningUrl\": \"https://netbankpp.instabank.de/#/loan/new?reference=57e942a5-4269-436f-8b34-5ab9ae371eb7\"\n },\n /*\n • Cancelled - The application is cancelled.\n • New - The application is in control, and is awaiting further manual handling.\n • Approved - The application has been approved, but is awaiting further handling.\n • Control - The application is in control, and is awaiting further manual handling.\n • Rejected - The application is rejected, and can be manually cancelled or will be automatically cancelled after a set amount of days.\n • DocumentsSent - The application has been approved, but is awaiting further handling.\n • DocumentsComplete - The application has been approved and documents are received, but the application is awaiting further internal handling/verification.\n • Complete - The application has been approved, and the loan is paid out.\n */\n \"Status\": \"Approved\",\n /*\n The common reference for the application. \n If specified in the request, it will be the same as in the request. If not, it's a generated GUID.\n */\n \"ExternalReference\": \"57e942a5-4269-436f-8b34-5ab9ae371eb7\",\n /*\n Instabank's internal reference for the application.\n */\n \"Sequence\": 3220114\n }\n}"}],"_postman_id":"0136a524-2183-4da1-9bf3-8f1dad53b874"}]}