> ## 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.

# /GetCategorization

> Returns categorized transactional data. This data is aggregated by Flinks through the /GetAccountsDetail endpoint.

Broad Categorization is a service at Flinks that provides financial and behavioural insights by assigning categories to your customers' transactions. The `/GetCategorization` endpoint is used by the Broad Categorization service and returns categorized transactional data. This data is aggregated by Flinks through the `/GetAccountsDetail` endpoint for the customer whose `loginId` is passed in the path parameter.


## OpenAPI

````yaml GET /v3/{customerId}/categorization/login/{loginId}/requestid/{requestId}
openapi: 3.0.3
info:
  title: Flinks API
  description: >
    Flinks API provides financial data connectivity, enrichment, and payment
    solutions.


    ## Authentication

    Endpoints require authentication using `flinks-auth-key` header (Bearer
    token).


    For more information, visit: https://docs.flinks.com
  version: 3.0.0
  contact:
    name: Flinks Support
    url: https://www.flinks.com/contact/sales
  termsOfService: https://www.flinks.com
servers:
  - url: https://{instance}-api.private.fin.ag
    description: Flinks API Environment
    variables:
      instance:
        default: toolbox
        description: The environment instance (e.g., toolbox, sandbox, production)
security: []
tags:
  - name: Authorization
    description: Endpoints for generating authorization tokens and authenticating requests
  - name: Enrich - Consumer Attributes
    description: Consumer financial attribute analysis and credit risk assessment
paths:
  /v3/{customerId}/categorization/login/{loginId}/requestid/{requestId}:
    get:
      tags:
        - Enrich
      summary: Get Categorization
      description: >-
        Returns categorized transactional data. This data is aggregated by
        Flinks through the /GetAccountsDetail endpoint.
      operationId: getCategorization
      parameters:
        - name: customerId
          in: path
          required: true
          schema:
            type: string
            default: 43387ca6-0391-4c82-857d-70d95f087ecb
          description: >-
            Unique GUID provided by Flinks that grants you access to the
            environment.
        - name: loginId
          in: path
          required: true
          schema:
            type: string
          description: >-
            A unique identifier that represents the login information for the
            customer.
        - name: requestId
          in: path
          required: true
          schema:
            type: string
          description: >-
            A unique identifier that represents a successful call to the
            /Authorize endpoint.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  HttpStatusCode:
                    type: integer
                    description: HTTP status code of the response.
                  LoginId:
                    type: string
                    description: Unique identifier for the end user's login.
                  RequestId:
                    type: string
                    description: GUID representing an authorized request to the API.
                  Transactions:
                    type: array
                    description: Array of categorized transaction records.
                    items:
                      type: object
                      properties:
                        Id:
                          type: string
                          description: Unique identifier for the transaction.
                        AccountId:
                          type: string
                          description: >-
                            Unique identifier for the account the transaction
                            belongs to.
                        Date:
                          type: string
                          format: date
                          description: Date of the transaction (YYYY-MM-DD).
                        Description:
                          type: string
                          description: >-
                            Raw description of the transaction as reported by
                            the financial institution.
                        Code:
                          type: string
                          nullable: true
                          description: >-
                            Transaction code from the financial institution, if
                            available.
                        Debit:
                          type: number
                          nullable: true
                          description: Debit amount (money out).
                        Credit:
                          type: number
                          nullable: true
                          description: Credit amount (money in).
                        Balance:
                          type: number
                          description: Account balance after the transaction.
                        CategoryId:
                          type: string
                          description: Unique identifier for the assigned category.
                        Category:
                          type: string
                          description: >-
                            Primary category name (e.g., "Income", "Transfers",
                            "Bills & Utilities").
                        SubCategory:
                          type: string
                          description: >-
                            Sub-category name within the primary category (e.g.,
                            "Payroll", "Telecom").
                        Type:
                          type: string
                          description: >-
                            Type of transaction (e.g., "Debit", "Credit",
                            "Transfer").
                        IsRecurring:
                          type: boolean
                          description: >-
                            Indicates whether the transaction is part of a
                            recurring series.
                        Merchant:
                          type: string
                          nullable: true
                          description: >-
                            Merchant name extracted from the transaction
                            description, when identifiable.
              example:
                HttpStatusCode: 200
                LoginId: a1b2c3d4-5e6f-7890-abcd-ef1234567890
                RequestId: f9e8d7c6-b5a4-3210-9876-543210fedcba
                Transactions:
                  - TransactionId: da4cb17a-2798-4eb0-a40a-69d3d1e1ae70
                    AccountId: 74141696-a808-4e6d-93b6-b758cdd749e7
                    Description: >-
                      Point of Sale - Visa Debit VISA Debit RETAIL PURCHASE
                      ATLANTIC LOTTER 215020217028
                    Category: Entertainment
                    SubCategory: Gambling
                    Balance: 2793.61
                    Debit: 10
                    Date: '2022-05-31'
                  - TransactionId: fafc01e8-1971-4ba3-b7a4-2105c326ef69
                    AccountId: 74141696-a808-4e6d-93b6-b758cdd749e7
                    Description: >-
                      Point of Sale - INTERAC RETAIL PURCHASE 215015119851 SP
                      CURLYS SPORT
                    Category: Food and Dining
                    SubCategory: Restaurants
                    Balance: 2803.61
                    Debit: 9.18
                    Date: '2022-05-30'
                  - TransactionId: 25176d2e-5f15-4d83-a104-d3d38652bf8a
                    AccountId: 74141696-a808-4e6d-93b6-b758cdd749e7
                    Description: >-
                      Point of Sale - INTERAC MDSE RETURN 000001001663 KENT
                      AMHERST
                    Category: Transfers and Adjustments
                    SubCategory: Balance Adjustment
                    Balance: 2812.79
                    credit: 268.03
                    Date: '2022-05-30'
                  - TransactionId: ffb757ef-7faf-441a-86f2-a799c9338e06
                    AccountId: 74141696-a808-4e6d-93b6-b758cdd749e7
                    Description: >-
                      Point of Sale - INTERAC RETAIL PURCHASE 214912259678 PITA
                      PIT
                    Category: Food and Dining
                    SubCategory: Fast Food
                    Balance: 2544.76
                    Debit: 34.24
                    Date: '2022-05-30'
                  - TransactionId: c3f3158b-909c-4969-b2e6-0d8e3139b4ce
                    AccountId: 74141696-a808-4e6d-93b6-b758cdd749e7
                    Description: >-
                      Point of Sale - INTERAC RETAIL PURCHASE 000001034052
                      CIRCLE K / IRVI
                    Category: Goods and Merchandise
                    SubCategory: General Merchandise
                    Balance: 2579
                    Debit: 5.3
                    Date: '2022-05-30'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  HttpStatusCode:
                    type: integer
                  Message:
                    type: string
                  FlinksCode:
                    type: string

````