Iconus Tech/Documentation

πŸš€ Quick Start

Get fraud protection working in 2 minutes!


Step 1: Get Your Free API Key

Run this command:

Get your API key
curl -X POST https://iconustech.com/api/request-api-key \
-H "Content-Type: application/json" \
-d '{"email": "you@company.com", "companyName": "Your Company"}'

You'll get:

json
{
"success": true,
"apiKey": "sk_free_abc123...", // πŸ‘ˆ Save this!
"tier": "FREE"
}

πŸ“Œ Copy your API key - you need it for the next step!


Step 2: Register a Check

When you write a check, register it:

Register a check
curl -X POST https://iconustech.com/api/v1/checks/register \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{"checkNumber": "1001", "amount": 1500.00, "payeeName": "John Smith"}'

You'll get:

json
{
"success": true,
"data": {
"qrToken": "qr_xyz789...", // πŸ‘ˆ Print this on your check!
"riskLevel": "LOW"
}
}

πŸ“Œ Print the qrToken as a QR code on your check!


Step 3: Verify a Check

When someone receives a check, they verify it:

Verify a check
curl -X POST https://iconustech.com/api/v1/checks/verify \
-H "Content-Type: application/json" \
-d '{"qrToken": "qr_xyz789..."}'

Safe check = βœ…

json
{
"success": true,
"fraudDetected": false,
"riskLevel": "LOW"
}

Fraud detected = 🚨

json
{
"success": false,
"fraudDetected": true,
"riskLevel": "HIGH",
"reasons": ["Check has been voided"]
}

πŸŽ‰ You're Done!

That's it! You now have fraud protection.

| Risk Level | Action | |------------|--------| | βœ… LOW | Accept the check | | ⚠️ MEDIUM | Review manually | | 🚨 HIGH | Reject it |


πŸ“š Learn More