Quick Start Guide

Get up and running with the SmartCard API in under 5 minutes.

Get an API Key

Sign up for a developer account and create your first API key from the Developer Portal.

Free Tier Available

Start with 1,000 free credits per month. No credit card required.

Install the SDK (Optional)

We provide official SDKs for JavaScript and Python. You can also use the REST API directly.

npm install @zocept/sdk

Make Your First API Call

Get personalized card recommendations based on spending history.

import { SmartCardClient } from '@zocept/sdk';

// Initialize client
const client = new SmartCardClient({
  apiKey: 'your_api_key_here'
});

// Get recommendations
const recommendations = await client.recommendations.get({
  transactions: [
    { amount: 1200, category: 'food', timestamp: '2024-01-15' },
    { amount: 5000, category: 'travel', timestamp: '2024-01-14' }
  ],
  preferences: {
    prioritize_cashback: true,
    max_annual_fee: 2000
  }
});

logger.debug(recommendations[0].reasoning.summary);

Handle the Response

The API returns ranked recommendations with detailed reasoning and value projections.

{
  "success": true,
  "data": {
    "recommendations": [
      {
        "rank": 1,
        "card": {
          "bank_name": "HDFC Bank",
          "card_name": "Millennia Credit Card",
          "annual_fee": 1000
        },
        "match_score": 87,
        "net_annual_value": 8500,
        "break_even_months": 2,
        "reasoning": {
          "summary": "Excellent value with ₹8,500 net annual benefit",
          "why_recommended": "Strong 5% cashback on your online spending"
        },
        "category_matches": [
          {
            "category": "online",
            "reward_rate": "5%",
            "monthly_value": 450,
            "annual_value": 5400
          }
        ]
      }
    ],
    "profile_summary": {
      "total_monthly_spend": 15000,
      "top_categories": ["food", "travel"]
    }
  },
  "meta": {
    "request_id": "req_123456",
    "credits_used": 15
  }
}

What's Next?

Need help with integration?

Check out our SDK documentation or contact support for assistance.