Skip to main content
This is the official Capital Check In API documentation. Here you’ll find all the information needed to integrate your application with our platform.

​
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 API allows you to integrate all these features into your application.

OpenAPI Specification

View the complete OpenAPI specification

​
Main Features

  • OAuth2 Authentication: Secure OAuth2 authorization flow for third-party integrations
  • Collaborator Management: Complete CRUD for employees
  • Geofencing: Location-based access control
  • Schedules: Flexible work schedule management
  • Reports: Detailed report generation

​
Base URL

https://api.capitalcheckin.app/v1

​
Authentication

Capital Check In API uses OAuth2 authorization flow:
  • OAuth2 Authorization Code: For third-party integrations

OAuth2 Authentication Guide

Learn more about OAuth2 implementation

​
Required Headers

Most endpoints require the following headers: 
Authorization: Bearer <your-oauth-token>
X-Company-Id: <company-id>
Content-Type: application/json
Accept: application/json

​
Response Codes

  • 200 - Successful operation
  • 201 - Resource created successfully
  • 400 - Bad request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Resource not found
  • 422 - Validation error
  • 500 - Internal server error

​
Rate Limiting

The API implements rate limiting to protect our services:
  • IP limit: 1000 requests per hour
  • User limit: 5000 requests per day
  • Response headers:
    • X-RateLimit-Limit: Request limit
    • X-RateLimit-Remaining: Remaining requests
    • X-RateLimit-Reset: Reset time (timestamp)

​
Support

If you need help with the API:
  • Documentation: This guide and code examples
  • Technical support: [email protected]
  • Community: Join our Slack
  • GitHub: Report issues in our repository