> ## Documentation Index
> Fetch the complete documentation index at: https://docs.capitalcheckin.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Capital Check In API

> Complete documentation for Capital Check In API - Employee check-in management system

# 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.

<Card title="Get Started Quickly" icon="rocket" href="/quickstart">
  Set up your first integration in minutes
</Card>

## Main Features

<CardGrid cols={2}>
  <Card title="Secure Authentication" icon="shield" href="/authentication/oauth2">
    OAuth2 authorization flow for secure third-party integrations
  </Card>

  <Card title="Collaborator Management" icon="users" href="/api-reference/collaborators/collaborators">
    Complete CRUD for employees with detailed profiles
  </Card>

  <Card title="Geofencing" icon="map-pin" href="/api-reference/management/geofences">
    Location-based access control
  </Card>

  <Card title="Flexible Schedules" icon="clock" href="/api-reference/management/schedules">
    Work schedule and shift management
  </Card>

  <Card title="Detailed Reports" icon="chart-bar" href="/api-reference/management/reports">
    Attendance and productivity report generation
  </Card>

  <Card title="OAuth2 Integration" icon="key" href="/authentication/oauth2">
    Complete authorization flow for third-party applications
  </Card>
</CardGrid>

## 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.

<Card title="OAuth2 Authorization Code" icon="shield" href="/authentication/oauth2">
  Implement OAuth2 in your application
</Card>

## 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:

```bash theme={null}
# 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": "your@email.com",
    "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": "your@email.com",
    "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

```javascript theme={null}
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

```python theme={null}
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

```php theme={null}
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

<CardGrid cols={2}>
  <Card title="API Status" icon="activity" href="https://status.capitalcheckin.app">
    Check the current status of our API
  </Card>

  <Card title="GitHub Repository" icon="github" href="https://github.com/capitalcheckin/platform">
    View our open source components
  </Card>

  <Card title="Community Forum" icon="users" href="https://community.capitalcheckin.app">
    Connect with other developers
  </Card>

  <Card title="Support" icon="help-circle" href="mailto:hi@capitalcheckin.app">
    Get help from our support team
  </Card>
</CardGrid>

## API Status

<StatusIndicator status="operational" />

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**: [hi@capitalcheckin.app](mailto:hi@capitalcheckin.app)
* **Community**: Join our Slack community
* **GitHub**: Report issues in our repository
* **Status Page**: Check API status and maintenance schedules

<Card title="Start Building" icon="code" href="/quickstart">
  Begin your integration journey
</Card>