How to use the API
This guide is intended to help you get going with your integration against the Loan Broker API in the Developer Portal. It serves as a complement to the Endpoint Reference and aims to bring a better understanding of the concepts of the platform.
For questions and support, please contact us at firstname.lastname@example.org
Changes and versioning
API version is provided in the base of the requested URL in the form of "v1", "v2" etc. Only major version numbers are used.
API versions are raised only on breaking (i.e. backwards incompatible) changes in the API. Fields may be added but will never be removed during an API version lifecycle. When developing your application, take care to ensure that your application can handle additional fields.
New feature 2023-05-12: As the role Broker. Use the endpoint startTenderPeriod to initiate a tender period. Required fields are brokerId, subjectId and countryCode.
To start a tender period without pulling a report - use the endpoint for broker and set the flag creditReport in the request to false. To start a tender period and also retrieve the LOAN BROKER report, set creditReport flag to true:
How to test
You can use the service with the test objects provided. As of today, there is no sand box environment for testing. For banks eligible to obtain credit registry data, the test objects with credit registry data are marked.
If you are a bank you will be using the same user/id when requesting the Broker report (to start a Tender session) and the Bank report. The reason for this is to make it easier for banks to test the solution. For a bank to connect to a Tender session, a Tender session must have been started. Only a Broker can start a Tender session.
The scope that should be used (if there is a choice) is LB-Broker if you are a broker and LB-Bank if you are a bank. As a bank you will have access to both for testing purposes.