Make test data use case API call

Data Use Case APIs build upon Open Banking data to deliver business-ready outputs that support onboarding, verification, risk assessment, lending, personal finance, and compliance workflows.

Unlike Raw Data APIs, which provide direct access to banking information, Data Use Case APIs process and analyze financial data to generate meaningful results that can be integrated directly into business applications.

Data Retrieval Flow

The following workflow illustrates a typical Data Use Case API journey:

Create Consent
↓
Customer Authorizes Consent
↓
Retrieve Consent Details
↓
Select Data Use Case Service
↓
Make API Request
↓
Receive Banking Data

Step 1: Create and Authorize a Consent

Open Banking data can only be accessed after obtaining explicit customer consent.

To create a consent:

1. Submit a Create Consent request
2. Define the permissions required by your application
3. Specify the consent validity period
4. Redirect the customer to complete authorization
5. Verify that the consent status is Authorized

Step 2: Retrieve Consent Details

Before making a data request, confirm that the consent is valid and active.

Use the Retrieve Consent Details endpoint to:

• Verify consent status
• Confirm granted permissions
• Validate consent expiration

Step 3: Make a Data Use Case API Request

Once consent has been authorized, you can request one of the available Data Use Case services.

The following use cases are available:

• Build Financial Insights
• • Aggregate accounts
  • Generate E-Statement
• Verify customers & accounts
• • Verify customer identity
  • Verify account ownership (Account Check)
  • Validate IBAN
  • Complete KYC check
• Assess financial position
• • Review available balances
  • Assess income
  • Assess expenses
  • Evaluate creditworthiness

Expected Response

A successful request returns processed insights based on the customer's authorized banking data.

The response may include:

• Verification results
• Financial indicators
• Account summaries
• Spending insights
• Income analysis
• Enriched transaction information

The information returned depends on the selected use case and the permissions granted through customer consent.