DEVELOPER API
One API. Every capability.
Parse, detect fraud, verify income — single REST API. Clean endpoints. Predictable responses.
Terminal
$
curl -X POST https://api.clearstaq.com/v1/parse \ -H "Authorization: Bearer cs_live_..." \ -F "[email protected]" \ -F "include_fraud=true" \ -F "include_income=true"
Your language. Your framework. Our data.
Python
Node.js
Go
Ruby
PHP
cURL
0
Core endpoints
0.0%
Uptime SLA
<0ms
Avg response time
0
Official SDKs
From zero to parsed data in 5 minutes
Three steps. That's it.
1
Get your API key
bash
export CLEARSTAQ_API_KEY="cs_live_your_key_here"
2
Upload a document
python
from clearstaq import ClearStaq
client = ClearStaq()
result = client.parse(
file="statement.pdf",
include_fraud=True,
include_income=True
)3
Use the data
python
for transaction in result.transactions:
print(f"{transaction.date}: {transaction.amount}")
print(f"Fraud score: {result.fraud_score}")
print(f"Monthly income: ${result.income.monthly_avg}")Clean endpoints. Predictable behavior.
Five endpoints cover everything you need.
POST
/v1/parseGET
/v1/documents/{id}GET
/v1/documentsPOST
/v1/batchGET
/v1/banksWEBHOOKS
Don't poll. We'll tell you.
Real-time notifications when documents are processed. Push, don't pull.
document.parsedDocument successfully parseddocument.failedParsing failed with errordocument.fraud_detectedHigh fraud score detectedbatch.completedAll batch documents processedHMAC-SHA256 signed • Auto-retry on failure • Delivery logs
webhook_payload.json
{
"event": "document.parsed",
"timestamp": "2025-01-15T14:30:00Z",
"data": {
"document_id": "doc_8x7Kp2mN",
"status": "completed",
"bank": "Chase",
"transaction_count": 47,
"fraud_score": 0.12,
"processing_time_ms": 3200
},
"signature": "sha256=a1b2c3..."
}Install and go
Official SDKs with TypeScript types, auto-retry, and streaming uploads.
Python
pip install clearstaqfrom clearstaq import ClearStaq
client = ClearStaq()
result = client.parse("statement.pdf")Node.js
npm install @clearstaq/sdkimport { ClearStaq } from '@clearstaq/sdk'
const client = new ClearStaq()
const result = await client.parse('statement.pdf')Go
go get github.com/clearstaq/goimport "github.com/clearstaq/go"
client := clearstaq.New()
result, _ := client.Parse("statement.pdf") TypeScript types Auto-retry Streaming upload Webhook verification
Rate limits & authentication
Rate Limits
Starter60 req/min
Professional300 req/min
EnterpriseCustom
Authentication
cs_live_Live keys
Production API access
cs_test_Test keys
Sandbox environment
Enterprise: IP allowlisting available