Skip to main content

​
Welcome to Capital Check In API

Capital Check In is a comprehensive platform for employee check-in management that includes identity verification, geolocation, and schedule management. This documentation will guide you through all aspects of our API.

Get Started Quickly

Set up your first integration in minutes

​
Main Features

​
Authentication Method

Capital Check In API uses OAuth2 authorization flow for secure third-party integrations:

​
OAuth2 Authorization Code

For third-party applications that need to access Capital Check In user resources.

OAuth2 Authorization Code

Implement OAuth2 in your application

​
Main Endpoints

Our API provides comprehensive endpoints for all aspects of employee management:
  • Authentication: Login, registration, password management
  • Users: Profile management and user settings
  • Companies: Company information and configuration
  • Collaborators: Complete employee management
  • Groups: Team and department organization
  • Lists: Custom employee groupings
  • Schedules: Work schedule management
  • Geofencing: Location-based access control

​
Quick Setup

Get started with our API in just a few steps: 
# 1. Register and get your credentials
curl -X POST https://api.capitalcheckin.app/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Your Name",
    "email": "[email protected]",
    "password": "secure_password",
    "company_name": "Your Company"
  }'

# 2. Login and get your token
curl -X POST https://api.capitalcheckin.app/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "secure_password"
  }'

# 3. Make your first authenticated request
curl -X GET https://api.capitalcheckin.app/v1/auth/user \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "X-Company-Id: YOUR_COMPANY_ID"

​
SDKs and Libraries

We provide SDKs and code examples for popular programming languages:

​
JavaScript/Node.js

import { CapitalCheckInAPI } from '@capitalcheckin/sdk';

const api = new CapitalCheckInAPI({
  baseURL: 'https://api.capitalcheckin.app/v1',
  token: 'your-jwt-token',
  companyId: 'your-company-id'
});

// Get collaborators
const collaborators = await api.collaborators.list();

​
Python

from capitalcheckin import CapitalCheckInAPI

api = CapitalCheckInAPI(
    base_url='https://api.capitalcheckin.app/v1',
    token='your-jwt-token',
    company_id='your-company-id'
)

# Get collaborators
collaborators = api.collaborators.list()

​
PHP

use CapitalCheckIn\CapitalCheckInAPI;

$api = new CapitalCheckInAPI([
    'base_url' => 'https://api.capitalcheckin.app/v1',
    'token' => 'your-jwt-token',
    'company_id' => 'your-company-id'
]);

// Get collaborators
$collaborators = $api->collaborators->list();

​
Additional Resources

​
API Status

Our API is currently operational with 99.9% uptime.

​
Upcoming Updates

We’re constantly improving our API. Here are some upcoming features:
  • Real-time Webhooks: Get instant notifications for check-ins and events
  • Advanced Analytics: Detailed insights and reporting
  • Mobile SDK: Native iOS and Android SDKs
  • Multi-language Support: API responses in multiple languages
  • Advanced Geofencing: Complex location rules and zones

​
Support

Need help? We’re here to support you:
  • Documentation: This comprehensive guide and code examples
  • Technical Support: [email protected]
  • Community: Join our Slack community
  • GitHub: Report issues in our repository
  • Status Page: Check API status and maintenance schedules

Start Building

Begin your integration journey