RESTful API Overview

The trst RESTful API provides standard HTTP endpoints for querying and managing your biometric authentication infrastructure. Use this API to manage projects, query enrollments, configure environments, and access analytics.

Base URLs

Environment	Base URL	Purpose
Production	https://api.trstinc.ca/v1	Live production data

Supported Authentication Methods

API Keys (Automated Systems):

• For backend services and integrations
• Format: {key_id}.{api_key}
• Can be scoped to organization or specific projects

curl https://api.trstinc.ca/v1/project/proj_abc123/devices \
  -H "Authorization: Bearer AbCd12...MnOp78.XyZ56...Stu90"

Interactive API Reference

Explore and test all API endpoints interactively. The interactive reference provides complete documentation for all resources including:

• API Keys - API credential management
• Projects - Project management endpoints
• Members - Member and user management
• Scans - Scan history and analytics
• Transactions - Transaction records
• Webhooks - Real-time event notifications
• Health - Health check endpoints

Open Interactive API Reference →

Real-Time Notifications

Looking for real-time event notifications? Check out Webhooks for push-based event delivery when enrollments complete, scans succeed, and more.

Making Your First Request

1. Obtain API Credentials

Follow the Obtaining Credentials guide to get your API key.

2. Get Project Details

curl https://api.trstinc.ca/v1/projects/proj_abc123xyz \
  -H "Authorization: Bearer YOUR_API_KEY"

Sample Response:

{
	"id": "proj_abc123xyz",
	"name": "Corporate Access Control",
	"phone_number": "555-555-5555",
	"website": "www.corporateca.ca"
}

Rate Limiting

API requests are rate-limited to ensure fair usage:

Plan	Rate Limit
Sandbox	5 requests/minute
Business	100 requests/minute
Enterprise	5,000 requests/minute

Best Practice: Implement exponential backoff when receiving 429 responses.

Versioning

The API version is included in the base URL: /v1

Breaking changes will result in a new API version (e.g., /v2). Non-breaking changes and additions are made to the current version.

Deprecation Policy: When a version is deprecated, we provide at least 12 months notice.

OpenAPI Specification

Download the complete OpenAPI 3.0 specification:

Download OpenAPI Spec

Import into tools like Postman, Insomnia, or generate client libraries.

Next Steps

1. Obtain API Credentials → - Get your API key
2. Explore Interactive API → - Test endpoints and view all resources
3. Read Authentication Guide → - Secure your API requests
4. Download OpenAPI Spec - Import into Postman or generate client libraries

Additional Resources

• Authentication → - API Key authentication
• Interactive API Reference → - Complete endpoint documentation
• Device-Com API → - Terminal device communication API

Support

Need help with the RESTful API?

• Documentation: Browse comprehensive guides
• Interactive Reference: Test endpoints directly
• Email: api-support@trstinc.ca
• GitHub: github.com/trst-id/trst-platform