API Reference
The WeCheck API Reference provides comprehensive documentation of endpoints, request/response schemas, authentication examples, and an interactive testing panel. This reference is automatically generated from WeCheck's OpenAPI specification and is always in sync with the live API.
Main Endpoints
The WeCheck API exposes three main endpoints for digital intelligence operations:
| Endpoint | Method | Description |
|---|---|---|
getDigitalFootprint | POST | Reconstructs a subject's public digital presence across all discoverable platforms. |
facialRecognition | POST | Identity validation through facial comparison with deep learning against a reference image. |
riskScoring | POST | Returns structured risk alerts and a confidence-weighted risk score for a subject. |
Complete schemas, required parameters, and payload examples for each endpoint are available in the interactive reference below.
Authentication
All API requests must include your API key as a Bearer token in the Authorization header:
Authorization: Bearer YOUR_API_KEY
API keys are managed in the Developer Settings section of the WeCheck dashboard. All requests must be made over HTTPS; plain HTTP requests will be rejected.
Base URLs
| Environment | Base URL | Notes |
|---|---|---|
| Production | https://api.wecheck.ai/v1 | Consumes real credits. |
| Sandbox | https://sandbox-api.wecheck.ai/v1 | For testing: does not consume real credits. |
Rate Limits
Standard tier: 50 requests per minute per API key. Enterprise clients can request higher limits through their account manager.
Requests exceeding the limit will return a 429 Too Many Requests response with a Retry-After header indicating when you can resume operations.
Interactive Reference
The full interactive API reference (including live testing panels, schema explorer, and code examples for cURL, Python, Node.js, and more) is available below.
Note: The interactive reference is generated from WeCheck's OpenAPI specification. If you need the raw specification file for integration with your own tooling, contact your WeCheck account manager.
Related Pages
- API Introduction: Integration patterns, environments, and limits.
- Webhooks: Asynchronous scan result delivery.
- Reading Webhook Reports: Interpreting result data.
- SDKs & Code Examples: Practical examples in major languages.