api-clients

Official API clients for the Cardscan.ai API, including Python, Typescript, Swift and more.

Available Clients

• TypeScript/JavaScript - Full-featured client with WebSocket support for real-time card scanning
• Python - Comprehensive Python client
• Swift - iOS/macOS client
• Dart - Flutter/Dart client
• Kotlin - Android/JVM client

TypeScript Client

Installation

npm install @cardscan.ai/cardscan-client

yarn add @cardscan.ai/cardscan-client

Quick Start

import { CardScanApi } from "@cardscan.ai/cardscan-client";

const cardScanApi = new CardScanApi({
  apiKey: "<your-api-key>",
});

// Example: Eligibility checking
const response = await cardScanApi.checkEligibility("<card-id>", {
  subscriber: {
    firstName: "John",
    lastName: "Doe",
    dateOfBirth: "18020101",
  },
  provider: {
    firstName: "John",
    lastName: "Doe",
    npi: "0123456789",
  },
});

Documentation

• TypeScript Client README - Complete installation and usage guide
• API Documentation - Detailed API reference for all models and endpoints:
  • CardScanApi - Main API interface
  • Models Documentation - All data models and types

Key Features

• Full Card Scanning: Upload front and back images with real-time processing via WebSockets
• Eligibility Checking: Verify insurance eligibility with comprehensive provider information
• TypeScript Support: Full type definitions for better development experience
• Multiple Environments: Support for production and sandbox environments
• File Upload: Direct image upload with automatic processing

For complete examples and advanced usage, see the TypeScript client documentation.

Python Client

Installation

pip install cardscan-client

Documentation

• Python Client README - Installation and usage guide
• Python API Documentation - Complete API reference

Other Clients

• Swift Client - iOS/macOS documentation
• Dart Client - Flutter/Dart documentation
• Kotlin Client - Android/JVM documentation

Generating clients

To generate a client using the openapi.yaml OpenAPI definition and a custom template from the templates/ folder, this command can be used:

openapi-generator generate -g <generator> -i openapi.yaml -o <output-dir> -c <config-file> -t templates/<template-dir>

Examples:

• TypeScript: openapi-generator generate -g typescript-axios -i openapi.yaml -o clients/cardscan-ts -c openapi-generator-configs/ts.config.json -t templates/typescript-template
• Python: openapi-generator generate -g python -i openapi.yaml -o clients/cardscan-python -c openapi-generator-configs/python.config.json -t templates/python-template
• Swift: openapi-generator generate -g swift5 -i openapi.yaml -o clients/cardscan-swift -c openapi-generator-configs/swift.config.json -t templates/swift-template

Repository Structure

api-clients/
├── clients/                    # Generated API clients
│   ├── cardscan-ts/           # TypeScript/JavaScript client
│   ├── cardscan-python/       # Python client
│   ├── cardscan-swift/        # Swift client
│   ├── cardscan-dart/         # Dart client
│   └── cardscan-kotlin/       # Kotlin client
├── templates/                  # Custom OpenAPI generator templates
├── openapi-generator-configs/  # Generator configuration files
├── tests/                     # Integration and unit tests
└── openapi.yaml              # OpenAPI specification

Contributing

Please refer to our contribution guidelines and ensure all tests pass before submitting pull requests.

License

This project is licensed under the terms specified in the individual client directories.