Skip to main content

Get All Dynamic Categories API

Overview​

Retrieve all dynamic categories with optional filtering and pagination support. Dynamic categories are used to organize and categorize different types of user documents and verification processes.

API Details​

Endpoint​

GET https://api.gafapay.com:8443/gafapay/v3/user/dynamic_category

Headers​

authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3NzMyNzA2fQ.EinJZTo8_g00dl_DFIQVttQFnDLyq8n0C-uDYb9_n3c
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: b35d332f-131e-44c1-892f-8322e022da74

Query Parameters​

Required Parameters​

  • company_id (String): Company identifier (passed in header)

Optional Parameters​

  • type (Integer): Category type filter
    • 1 = KYC (Know Your Customer)
    • 2 = Registration
    • 3 = Business
  • user_type (Integer): Type of user this category applies to
    • 2 = Customer
    • 3 = Merchant
    • 5 = Agent
  • category_key (String): Specific category key filter
  • display_order (Integer): Display order filter
  • is_default (Boolean): Filter for default categories
  • no_of_doc_required (Integer): Number of documents required filter
  • ir_country_id (String): International regulation country ID filter
  • skip (Integer): Number of records to skip (pagination)
    • Default: 0
    • Example: 0, 10, 20
  • limit (Integer): Maximum number of records to return (pagination)
    • Default: 10
    • Example: 10, 25, 50
  • search_keyword (String): Search data using any keyword (searches name and category_key)
  • sorting (String): Sorting criteria (JSON format)
    • Example: {"display_order": "ASC"}
  • start_date (Long): Start date filter (epoch timestamp)
  • end_date (Long): End date filter (epoch timestamp)
  • is_active (Boolean): Active status filter

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "dynamic_category": [
            {
                "is_active": true,
                "created_by": "b87d383d91fe48e58024f8344ba3273c",
                "created_date": 1678359446,
                "updated_by": "b87d383d91fe48e58024f8344ba3273c",
                "updated_date": 1701683244,
                "id": "613680fd33f14e229ea5f6488a779706",
                "name": "Selfie",
                "category_key": "selfie_1_2",
                "display_order": 7,
                "type": 1,
                "is_default": false,
                "no_of_doc_required": 1,
                "user_type": 2,
                "ir_country_id": null
            },
            {
                "is_active": true,
                "created_by": "640b793d04e2428dbf19ab10399f4edb",
                "created_date": 1676545789,
                "updated_by": "640b793d04e2428dbf19ab10399f4edb",
                "updated_date": 1678871019,
                "id": "97733bc377a740dfb8114d2991ad8611",
                "name": "KYC Documents ",
                "category_key": "KYC",
                "display_order": 3,
                "type": 1,
                "is_default": false,
                "no_of_doc_required": 1,
                "user_type": 2,
                "ir_country_id": null
            }
        ]
    }
}

Response Fields​

  • success (integer): Response status indicator
    • 1 = Success
    • 0 = Failure
  • error (array): Array of error messages (empty on success)
  • data (object): Response data object
    • dynamic_category (array): Array of dynamic category objects

Dynamic Category Object Fields​

  • id (string): Category unique identifier
  • name (string): Category display name
  • category_key (string): Unique category key identifier
  • display_order (integer): Order for display purposes
  • type (integer): Category type
    • 1 = KYC (Know Your Customer)
    • 2 = Registration
    • 3 = Business
  • is_default (boolean): Whether this is a default category
  • no_of_doc_required (integer): Number of documents required for this category
  • user_type (integer): Type of user this category applies to
    • 2 = Customer
    • 3 = Merchant
    • 5 = Agent
  • ir_country_id (string|null): International regulation country ID
  • is_active (boolean): Category active status
  • created_date (long): Creation timestamp (epoch)
  • created_by (string): ID of the user who created the category
  • updated_by (string|null): ID of the user who last updated the category
  • updated_date (long|null): Last update timestamp (epoch)

Example Usage​

Basic Request​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/user/dynamic_category?type=1&user_type=2' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3NzMyNzA2fQ.EinJZTo8_g00dl_DFIQVttQFnDLyq8n0C-uDYb9_n3c' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: b35d332f-131e-44c1-892f-8322e022da74'
curl --location 'https://api.gafapay.com:8443/gafapay/v3/user/dynamic_category?type=1&user_type=2&skip=0&limit=10&search_keyword=KYC' \
--header 'authorization: Token YOUR_TOKEN_HERE' \
--header 'companyid: YOUR_COMPANY_ID' \
--header 'requestid: YOUR_REQUEST_ID'

Category Type Constants​

  • KYC = 1: Know Your Customer verification categories
  • Registration = 2: User registration process categories
  • Business = 3: Business verification categories

User Type Constants​

  • Customer = 2: Regular customer users
  • Merchant = 3: Merchant/business users
  • Agent = 5: Agent/representative users

Notes​

  • Display Order: Categories are typically ordered by display_order for consistent UI presentation
  • Category Keys: Auto-generated based on user type and category type, but can be customized
  • Search: The search_keyword parameter searches both category name and category key
  • Pagination: Use skip and limit parameters for efficient data retrieval