Skip to main content
Version: v3

Periodical Income Service

The Periodical Income Service predicts fixed and regular income sources. It identifies recurring income transactions, including:

  • Salary/Benefits: Income from various employers or government benefits.
  • Taxes: Periodic tax returns.
  • Allowances: Support payments such as child support.
  • Other Income: Alimony, retirement funds, student grants, etc.
  • Internal Transfers: Regular income from other personal accounts.

Key Features​

  • Predictable Income Detection: Identifies consistent income sources based on transaction patterns.
  • Income Categorization: Automatically assigns income sources to relevant categories.
  • Frequency and Probability Analysis: Provides probability ratings and frequency assessments for recurring income.
  • Detailed Metadata: Includes account and business metadata for enhanced insights.

How to Use the Periodical Income Service​

To call the Periodical Income Service, include the required headers and payload parameters.

Required Headers​

  • ApiKey (string, required): Authentication key for API access.
    • Format: UUID
  • X-Request-ID (string, required): Unique request identifier for tracking purposes.
    • Format: UUID
  • ClientId (string, optional): Identifier for the client application.
  • ConsentCollectionId (string, optional): Identifier for PSD2 data consent.
    • Format: UUID

Request Body​

  • File (binary, optional): Binary data for processing. Can be omitted if using ConsentCollectionId.
  • Options (integer, optional): Configurable option flags. Default: 33.

Response​

Upon successful completion, the service returns an array of detected income transactions with relevant account and transaction metadata.

Example Output Structure​

  • Account Information: Details on the account associated with each income, including identifiers, IBAN, and country information.
  • Items Array:
    • Income Details:
      • probability (string): Likelihood of the transaction being recurring (e.g., Medium, High).
      • frequenceType (integer): Frequency type of the income (e.g., monthly, quarterly).
      • amount (decimal): Expected recurring income amount.
      • category (object): Classification of income type (e.g., salary, grant).
    • Transaction Metadata:
      • id (string): Unique identifier for the transaction.
      • bookDate (date): Date when the transaction was recorded.
      • amount (decimal): Amount of the income transaction.
      • beneficiary (object): Information about the payer or income source.
      • description (string): Text description of the transaction.

Calling the Periodical Income Service​

Please refer to the API reference for the Periodical Income service for all technical details on how to call this service.