This documentation describes planned API and dashboard features. Dashboard and API access are coming soon. For now, request a demo via the Contact page.
API Documentation
Everything you need to integrate ShieldPoint fraud detection solutions into your systems.
🚀 Getting Started
Overview
The ShieldPoint API provides real-time fraud detection and prevention capabilities for financial institutions. Our API is built on REST principles and uses JSON for request and response payloads.
Base URL
Requirements
- API Key (obtained from your ShieldPoint dashboard)
- HTTPS connection (all requests must be encrypted)
- Valid JSON payloads
- Proper request headers including Content-Type and Authorization
🔐 Authentication
API Key Authentication
All API requests must include your API key in the Authorization header:
Obtaining Your API Key
- Log into your ShieldPoint dashboard
- Navigate to Settings → API Keys
- Click "Generate New Key"
- Store your key securely (you won't be able to view it again)
📡 API Endpoints
Transactions
Analyze a transaction for fraud risk
Get transaction details and fraud score
Alerts
List all fraud alerts for your institution
Mark an alert as reviewed
Note: Full endpoint documentation with request/response examples coming soon. Contact our support team for detailed specifications.
🔔 Webhooks
Real-Time Events
Receive instant notifications when fraud alerts are triggered or transactions are flagged.
Supported events:
- fraud_alert_triggered
- transaction_flagged
- anomaly_detected
- alert_acknowledged
Setup Instructions: Configure webhooks in your ShieldPoint dashboard under Settings → Webhooks.
⚠️ Error Codes
| Status Code | Error Type | Description |
|---|---|---|
| 200 | OK | Request successful |
| 400 | Bad Request | Invalid parameters or malformed request |
| 401 | Unauthorized | Invalid or missing API key |
| 429 | Rate Limited | Too many requests - exceeded rate limit |
| 500 | Server Error | Internal server error - contact support |
📚 SDKs & Libraries
Official SDKs are available for popular programming languages to simplify integration:
Python
Coming Soon
JavaScript/Node.js
Coming Soon
Java
Coming Soon
C#/.NET
Coming Soon
Need Help?
Our technical team is here to support your integration. Reach out via email, support portal, or schedule a call with our solutions team.