šŸš€ Quick Start Guide

Integrate CIRS review fraud detection into your platform in under 5 minutes

ā±ļø ~5 minutes to first API call
1

Get Your API Key

Contact us to receive your sandbox API key for testing. Production keys are available after partnership agreement.

# Your API key will look like this:
X-API-Key: cirs_sandbox_demo_key_2024

# For production:
X-API-Key: cirs_live_your_unique_key_here
šŸ’” Tip: Use our API Playground to test endpoints immediately with the sandbox key.
2

Make Your First API Call

Test the health endpoint to verify your connection:

curl -X GET "https://trustcirs.com/api/health"

āœ… Expected Response:

{
  "status": "healthy",
  "version": "2.0.0",
  "timestamp": "2026-01-23T12:00:00Z"
}
3

Analyze a Single Review

Send a review to get fraud detection scores and classification:

curl -X POST "https://trustcirs.com/api/v1/analyze" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: cirs_sandbox_demo_key_2024" \
  -d '{
    "review_text": "Amazing hotel! Staff was helpful.",
    "rating": 5,
    "name": "John Smith",
    "total_number_of_reviews_by_reviewer": 12,
    "is_local_guide": true
  }'

āœ… Response includes:

{
  "cts_score": 78,           // Composite Trust Score (0-100)
  "classification": "TRUSTED", // TRUSTED, SUSPICIOUS, or FLAGGED
  "flags": [],               // Any detected issues
  "confidence": 0.85         // Model confidence
}
4

Batch Processing with Proof Pack

Process multiple reviews and get a cryptographic proof of analysis:

curl -X POST "https://trustcirs.com/api/v1/batch" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: cirs_sandbox_demo_key_2024" \
  -d '{
    "reviews": [
      {"review_text": "Great stay!", "rating": 5},
      {"review_text": "Terrible experience", "rating": 1},
      {"review_text": "Average hotel", "rating": 3}
    ]
  }'
šŸ” Proof Pack: The response includes a proof_pack with Merkle root hash - cryptographic proof that can be verified later to ensure data integrity.
5

Verify a Proof Pack

Verify the integrity of previously analyzed data:

curl -X POST "https://trustcirs.com/api/v1/verify" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: cirs_sandbox_demo_key_2024" \
  -d '{
    "batch_id": "batch_abc123",
    "merkle_root": "8a7f3b2c...",
    "leaf_hashes": ["hash1", "hash2", "hash3"]
  }'

āœ… Verification Result:

{
  "valid": true,
  "message": "Merkle root verified successfully",
  "checks": {
    "merkle_root_verified": true,
    "leaf_count_match": true,
    "hash_algorithm": "SHA-256"
  }
}
āœØ

Integration Examples

Quick code snippets for popular languages:

JavaScript / Node.js

const response = await fetch('https://trustcirs.com/api/v1/analyze', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': process.env.CIRS_API_KEY
  },
  body: JSON.stringify({
    review_text: reviewText,
    rating: rating
  })
});

const result = await response.json();
console.log(`Trust Score: ${result.cts_score}`);

Python

import requests

response = requests.post(
    'https://trustcirs.com/api/v1/analyze',
    headers={
        'Content-Type': 'application/json',
        'X-API-Key': CIRS_API_KEY
    },
    json={
        'review_text': review_text,
        'rating': rating
    }
)

result = response.json()
print(f"Trust Score: {result['cts_score']}")
āš ļø Rate Limits: Sandbox API is limited to 100 requests/hour. Production keys have higher limits based on your plan. Contact us for enterprise volume.

Ready to Integrate?

Try the API playground or contact us for production access

šŸŽ® Try API Playground šŸ“§ Contact Us