| Table of Contents |
|---|
1. Data Source Import
The following types of data sources can now be created in DI:
Bank Connection data sources (imported via Web Form 2.0)
Schufa Credit Check data sources (provided by Schufa WS)
Bank Connection Data Source
Initial Import
...
| Table of Contents |
|---|
1. Data Source Import
The following types of data sources can now be created in DI:
Bank Connection data sources (imported via Web Form 2.0)
Schufa Credit Check data sources (provided by Schufa WS)
Bank Connection Data Source
Initial Import
The major prerequisites for creating a data source in DI is:
Obtaining a user access token from Access
...
Data source synchronization call returned bank connection in status
FAILEDCalling GET/dataSources/{dataSourceId}/status resulted in status
FAILEDand codeUPDATE_REQUIRED.
...
NOTE: The maxDaysForCase parameter limits the range of data provided in Bank Connection Data Sources, but does not influence in any way the data inside the Schufa Credit Check Data Source.
3. Reports Creation & Getting
.
3. Reports Creation & Getting
Risk, Cash Flow, B2B, Contracts Reports
The major prerequisite for creating and getting the report is having the caseId of the successfully created case file from Step 2.
To create a report of a particular type (Chargebacks, Gambling, B2B Balances, Insurance) and of particular category (Risk, Cash Flow, B2B, Contracts
...
The major prerequisite for creating and getting the report is having the caseId of the successfully created case file from Step 2.
...
NOTE: If there is a need for report to be re-generated automatically in particular time periods without additional user interaction, the interval and intervalPeriod fields need to be specified. Such a report will be considered continuous and will have associated with it child reports, created automatically inside of the same case file.
NOTE: In case the report is considered continuous, the time span of transactions, that will be analysed for child reports is defined by interval and intervalPeriod , not by maxDaysForCase parameter.) , make a call to POST/cases/{caseId}/reports/ <report_category>/<report_type>.
NOTE: If there is a need for report to be re-generated automatically in particular time periods without additional user interaction, the interval and intervalPeriod fields need to be specified. Such a report will be considered continuous and will have associated with it child reports, created automatically inside of the same case file.
NOTE: In case the report is considered continuous, the time span of transactions, that will be analysed for child reports is defined by interval and intervalPeriod , not by maxDaysForCase parameter.
| Info |
|---|
Continuous Report Creation Example In case the user wants Income Report to be re-generated on Monday once per two weeks AND every 5th day of the month, the request body should look as follows: |
To get a report of a particular type (Chargebacks, Gambling, B2B Balances, Insurance) and of particular category (Risk, Cash Flow, B2B, Contracts) , make a call to GET/cases/{caseId}/reports/ <report_category>/<report_type>.
NOTE: Every case file may have maximum one report of a particular type: e.g. 1 case file may have 1 Chargebacks report, 1 Gambling report and 1 Insurance Report (child reports are not taken into account for this count).
...
The case file id returned in the response of the call should be used as an input path parameter for GET cases/{caseId}/reports to retrieve the DAC report results.
...
Select one of the pre-defined triggers via POST /reports/{reportId}/triggers/cashFlow
Create your own trigger via POST /reports/{reportId}/triggers
Pre-defined triggers
For example, if the client wants to get notified, when the user’s salary amount will change, he can use SALARYAMOUNTCHANGE pre-defined trigger. For this make a call to POST /reports/{reportId}/triggers/cashFlow with the triggerType = SALARYAMOUNTCHANGE and reportId of the created by the client continuous Income Report, that contains salary transactions.
...
For example, if the client wants to get notified once the user concluded a new health insurance contract, the following trigger for continuous Contracts Report for Insurances can be set via POST /reports/{reportId}/triggers. To do this the client should find the contracts of contractType= HEALTHINSURANCE AND newContract=true, to ensure that the contract is new for the user.
...
In case it is needed to remove the DI data of the user, such as the created Data Sources, Reports, Cases, theDELETE/ userendpoint can be used.
To delete the user’s data it is mandatory to pass a valid user access_token.
...
To ensure whether the deletion process has been finalized for the user, the obtained deletionId should be used for GET /user/status/delete/{deletionId}call. The response of the call is aimed at providing the detailed data on the status of data deletion at each DI module (application).
...