Product Finder

Retrieve Financial Products V2

The GET /insights/v2/products endpoint provides a list of a customer's financial products based on their previous transactions.

📘

Please note financial products are only identified from debit transactions. Additionally, if the from and to parameters are not set the endpoint will default to only analysing transactions from the last six months, this is the recommended date range in order to identify up to date products.

This endpoint will return a list of the given customer's financial products. An example of a 200 response can be seen below.

{
  "operation_id": "insights_v2_products",
  "data": [
    {
      "type": [
        "credit_card"
      ],
      "merchant": {
        "id": "bankofamericacorporation",
        "logo": "https://assets.thisisbud.com/bud-datasci-images/merchant_logos/e121c7aa-a254-41bb-ad3e-33b988f791be/v1/nationwidebuildingsociety.jpeg",
        "name": "Bank of America"
      },
      "amount": {
        "value": "0.03",
        "currency": "USD"
      },
      "period": "unknown"
    },
    {
      "type": [
        "insurance"
      ],
      "merchant": {
        "id": "statefarm",
        "logo": "https://assets.thisisbud.com/bud-datasci-images/merchant_logos/c50be401-7891-44c5-9fed-535080e77c57/v1/aviva.jpeg",
        "name": "State Farm"
      },
      "amount": {
        "value": "59.99",
        "currency": "USD"
      },
      "period": "monthly"
    }
  ],
  "metadata": {
    "from": "2022-09-03T11:28:22.00Z",
    "to": "2023-03-03T11:28:22.00Z",
    "results": 2
  }
}

curl --request GET \
     --url https://api-sandbox.thisisbud.com/insights/v2/products \
     --header 'X-Client-Id: <client_id>' \
     --header 'X-Customer-Id: <customer_id>' \
     --header 'accept: application/json'

This response will contain a list of a customer's financial products including information about the type, merchant, amount and period. Currently, the following types are supported:

• Loans
• Buy Now, Pay Later (BNPL)
• Mortgages
• Insurance Products
• Credit Cards
• Retirement Plans
• Savings and Investments

If you receive a 400 response like below, please check the headers you're sending in the request before trying again. If you continue to receive an error please consult the error responses guide.

{
  "operation_id": "insights_v2_products",
  "code_id": "failed_validation",
  "message": "Invalid request payload.",
  "errors": [
    "invalid 'from' date: '7th March 2023'"
  ]
}

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.