Source of Wealth

Generate source of wealth statements for customers using AIS bank data. This provides balance snapshots and identifies income sources based on transaction history.

⚠️ REQUIRES TENANT KEY: Source of wealth endpoints require a tenant-scoped API key. Merchant keys (from the TrustistTransfer app) will not work. Contact Trustist support to request a tenant key.

Overview

Source of wealth statements are generated from AIS data collected during onboarding or payment flows. Customers must have a valid AIS token with the required scopes (balances and/or transactions).

  • Balances provide an account snapshot for affordability checks.
  • Transactions allow identification of income sources and regular deposits.

Endpoints

Get Source of Wealth (Customer)

GET /v1/customers/{customerId}/source-of-wealth

Required Permissions: read_customer

Query Parameters:

  • format (optional) - json (default) or pdf
  • merchantId (optional) - Use when your tenant manages multiple merchants

Get Source of Wealth (Payment Context)

GET /v1/customers/{customerId}/payments/{paymentId}/source-of-wealth

Required Permissions: read_customer

When called with a payment ID, the statement includes the payment amount for compliance context.

Example Response (JSON)

{
  "customer": {
    "firstName": "Sarah",
    "lastName": "Johnson",
    "city": "London"
  },
  "accounts": [
    {
      "account": {
        "bankName": "Barclays",
        "accountHolderName": "Sarah Johnson",
        "accountNumber": "xxxx1234",
        "sortCode": "xx-01-32",
        "currency": "GBP"
      },
      "currentBalance": 1250.50,
      "dataAvailability": {
        "balanceAvailable": true,
        "transactionsAvailable": true
      }
    }
  ],
  "primarySource": {
    "description": "ABC Football Club",
    "amount": 2500.00,
    "frequency": 3,
    "totalValue": 7500.00,
    "context": "Regular monthly income (3 payments in last 89 days)",
    "type": "SALARY"
  },
  "additionalSources": [
    {
      "description": "Freelance Payments",
      "amount": 600.00,
      "frequency": 2,
      "totalValue": 1200.00,
      "type": "BUSINESS_INCOME"
    }
  ],
  "generatedAt": "2026-01-22T10:15:00Z"
}

PDF Output

To download a PDF statement, add ?format=pdf to the request. The response will be a PDF file.

Common Errors

Status Error Description
401 invalid_token Missing or invalid tenant API key
404 not_found Customer not found or no AIS data available

Related Documentation