Skip to main content
GET
/
api
/
v2.1
/
customer
/
individual
/
categorization
/
hierarchy
/
{tenantId}
cURL
curl --request GET \
  --url https://sandbox.finhub.cloud/api/v2.1/customer/individual/categorization/hierarchy/{tenantId} \
  --header 'Authorization: <authorization>' \
  --header 'X-Forwarded-For: <x-forwarded-for>' \
  --header 'X-Forwarded-From: <x-forwarded-from>' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --header 'deviceId: <deviceid>' \
  --header 'platform: <platform>'

Individual Categorization Hierarchy

Returns customer category options used before registration.

Endpoint

GET /api/v2.1/customer/individual/categorization/hierarchy/{tenantId}

Path Parameters

tenantId
string
required
Tenant UUID. Example: 97e7ff29-15f3-49ef-9681-3bbfcce4f6cd

Required Headers

Example

cURL
curl -X GET "https://sandbox.finhub.cloud/api/v2.1/customer/individual/categorization/hierarchy/97e7ff29-15f3-49ef-9681-3bbfcce4f6cd" \
  -H "X-Tenant-ID: 97e7ff29-15f3-49ef-9681-3bbfcce4f6cd" \
  -H "Authorization: Bearer YOUR_ADMIN_TOKEN"

Success Response

200
{
  "code": 200,
  "data": {
    "tenantId": "97e7ff29-15f3-49ef-9681-3bbfcce4f6cd",
    "categories": {
      "INDIVIDUAL_STANDARD": {
        "databaseId": "fs-cat-b2c-low-001",
        "categoryName": "Individual Standard"
      },
      "B2B_SMALL_BUSINESS": {
        "databaseId": "fs-cat-b2b-small-001",
        "categoryName": "Small Business"
      }
    }
  },
  "message": "Success"
}
Used by B2C/B2B step runners before registration (Step 2).

Headers

X-Forwarded-For
string
required
X-Tenant-ID
string
required
X-Forwarded-From
string
required
platform
string
required
deviceId
string
required
Authorization
string
required

Path Parameters

tenantId
string
required

Response

200

OK