Skip to main content
GET
/
v3
/
{customerId}
/
BankingServices
/
Categories
/
{CountryCode}
Categories
curl --request GET \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices/Categories/{CountryCode}
[
  {
    "PrimaryCategoryName": "<string>",
    "Description": "<string>",
    "SubCategories": [
      {
        "SubCategoryName": "<string>",
        "Description": "<string>"
      }
    ]
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.flinks.com/llms.txt

Use this file to discover all available pages before exploring further.

Broad Categorization is a service at Flinks that provides financial and behavioural insights by assigning categories to your customers’ transactions. The /Categories endpoint returns an up-to-date list of all categories that can be applied to your customers’ transactional data in either Canada or the US.

Headers

​
Authorization
string
default:Bearer {API Secret}

Contains the Bearer Token (the API secret key that Flinks provides you with).

Path Parameters

​
customerId
string
default:43387ca6-0391-4c82-857d-70d95f087ecb
required

Unique GUID provided by Flinks that grants you access to the environment specified in the instance field.

​
CountryCode
string
default:CA
required

Identifies the country of the library that you wish to return. Accepted values are CA for Canada or US for the United States.

Response

Result

​
PrimaryCategoryName
string
​
Description
string
​
SubCategories
object[]