API Introduction
Welcome to the WeCheck Developer Manual. This section provides the narrative context and architecture patterns needed to integrate WeCheck's digital intelligence into your own applications.
Integration Patterns
Most developers use WeCheck in two main ways:
- Real-time verification: Triggering a scan during a user's onboarding or registration process to assess risk instantly.
- Batch investigation: Processing a list of subjects through the engine as part of a recurring compliance audit or pre-litigation discovery phase.
Authentication
WeCheck uses API Keys to authorize requests. All API requests must be made over HTTPS; calls made over plain HTTP will fail.
You can manage your API keys in the Developer Settings section within the WeCheck dashboard.
Header Example
Include your key in the Authorization header as a Bearer token:
Authorization: Bearer YOUR_API_KEY
Environments
We provide two distinct environments for development and production:
| Environment | Base URL | Purpose |
|---|---|---|
| Sandbox | https://sandbox-api.wecheck.ai/v1 | Testing and development. Does not consume real credits. |
| Production | https://api.wecheck.ai/v1 | Real investigations. Consumes active credit balance. |
Rate Limits & Latency
- Rate Limiting: Our standard tier allows up to 50 requests per minute. Enterprise clients can request higher throughput.
- Latency: The engine is optimized for speed, with an average response time of ~0.78 seconds per investigation.
Next Steps
- Learn how to handle asynchronous results in our Webhooks Guide.
- Access the technical specifications directly in our API Reference.