Scopes
Your client is assigned a set of scopes during creation. Scopes define which services and endpoints can be accessed by your client.
At the moment, scopes can only be assigned or modified manually by one of our engineers. If you would like to enable or disable specific scopes or services, please contact us.
To determine which scopes are required for your integration, refer to the endpoints and services you plan to use. The required scope is documented for each endpoint.
Banking Scopes
| Scope | Description |
|---|---|
| banking-fetch | Fetch raw accounts and transactions |
| banking-connect | Connect to XS2A interfaces to retrieve accounts and transactions and enable automatic daily data synchronization |
| banking-upload | Upload raw accounts and transactions |
| banking-payment | Authorize payment initiation |
General Analysis Scopes
| Scope | Description |
|---|---|
| categorization | Transaction categorization and tagging based on analysis |
| account-detection | List of uploaded or XS2A-retrieved accounts, including additional detected accounts |
| account-history | Daily balances for all accounts |
| contracts | Detection of contracts based on tags and other characteristics |
| cockpits | Consolidated overview of analysis results |
Person Analysis Scopes
| Scope | Description |
|---|---|
| credit-rating | Indicators used for credit rating calculations |
| renter-information | Summary of salary and rental information |
| name-verification | Comparison of the provided user name with the registered account holder’s name |
| person-income-alimony | Alimony and maintenance payments received |
| person-income-child-benefit | Child allowances from public authorities or family members |
| person-income-investment | Capital income from securities, dividends, and investment returns |
| person-income-other | Other miscellaneous income sources not covered by specific categories |
| person-income-parental-allowance | Parental leave benefits and allowances |
| person-income-pension | Pension and retirement income payments |
| person-income-rental | Rental income from real estate and property leasing |
| person-income-salary | Employment income including wages, salaries, and bonuses |
| person-income-self-employment | Income from self-employment and freelance work |
| person-spending-credit | Loan instalments and credit repayments |
| person-spending-credit-card | Credit card payments and monthly settlements |
| person-spending-insurance | Insurance premiums and policy payments |
| person-spending-investment | Investment contributions, savings plans, and securities purchases |
| person-spending-other | Miscellaneous recurring and irregular expenses |
| person-spending-rent | Rent and lease payments for residential and commercial properties |
| person-risk-back-debit | Number of returned direct debits per calendar month |
| person-risk-garnishment | Number of garnishment payments per calendar month |
| person-risk-collection | Number of payments to debt collection agencies per calendar month |
| person-risk-gambling | Number of gambling transactions with accumulated amounts per month |
| person-risk-overdraft-amount | Number of overdraft days per calendar month with corresponding amounts |
| person-household-budget | Overview of income and spending patterns |
| person-adult-check | Verifies the age status of account holders |
Company Analysis Scopes
| Scope | Description |
|---|---|
| company-cash | Analysis and overview of company cash flow |
| company-credit | Information on company credits, loans, and leasing agreements |
| company-customer-supplier | Evaluation of customer and supplier relationships |
| company-foreign-payment | Analysis of foreign and international transactions |
| company-insurance | Overview and analysis of existing insurance contracts |
| company-internal-booking | Detection and evaluation of internal bookings between connected accounts |
| company-investment | Analysis of investments, such as savings and securities |
| company-liquidity | Calculation and monitoring of company liquidity, including monthly income and expenses |
| company-risk | Assessment of company risk indicators, such as account overdrafts |
| company-spending-other | Analysis of other recurring expenses |
| company-staff | Evaluation of personnel costs and employee-related data |
| company-top-category | Overview of the most relevant expense categories |
Other Scopes
| Scope | Description |
|---|---|
| webhooks | Create webhooks to receive notifications and analysis results |
| categorization-categories | Category hierarchy with localized descriptions (German and English) |
| companies | Search for companies to retrieve additional company data |
| companiesLogo | Search for companies and retrieve their logos |