API Reference

Complete API documentation for programmatic access to reqCHECK.

Authentication

How to authenticate API requests

All API requests require authentication using an API key. Generate API keys from Settings → API & Webhooks in your dashboard.

Include your API key in the x-api-key header:

x-api-key: rk_live_your_api_key_here

Security: API keys are only used in your backend for token verification. Never commit them to version control, expose them in client-side code, or include them in the widget script. The widget uses Company ID, not API keys.

Base URL

API endpoint

https://api.reqcheck.com/v1

Endpoints

Available API endpoints

POST /api/v1/verify

Check if a candidate has passed verification for a specific job. This endpoint is called from your backend when processing application submissions.

POST /api/v1/verify
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "externalJobId": "job_123",
  "email": "candidate@example.com"
}

Request Body

externalJobId (string, required) - The external job ID
email (string, required) - The candidate's email address

Response (200 OK)

{
  "verified": true,
  "passed": true,
  "score": 85,
  "completedAt": "2024-01-15T10:30:00Z",
  "expiresAt": "2024-01-15T11:30:00Z"
}

verified (boolean) - Whether a valid verification was found
passed (boolean) - Whether the candidate passed the quiz
score (number, optional) - The candidate's score percentage
completedAt (string, optional) - ISO 8601 timestamp when verification completed
expiresAt (string, optional) - ISO 8601 timestamp when verification expires

Response (404 Not Found)

{
  "verified": false,
  "message": "No valid verification found. Candidate must complete skill quiz."
}

Returns 404 if no valid verification found within 1-hour TTL.

Important: Verifications are stored server-side in the VerificationAttempt table with a 1-hour expiry. No tokens are injected into forms. This endpoint should only be called from your backend, never from frontend code.

Rate Limits

API usage limits

API requests are rate-limited to ensure fair usage:

Free: 100 requests/hour
Pro: 1,000 requests/hour
Enterprise: Custom limits based on contract

Rate limit headers are included in all responses:X-RateLimit-Remaining