Integration Overview
This guide provides comprehensive documentation for integrating the risk validation API into your application. The API provides real-time risk assessment for user actions, transactions, and events.
What You'll Learn
- Client-Side Integration: JavaScript SDK for browser-based applications
- Server-Side Integration: REST API for backend services
- Authentication: Securing your API requests
- Error Handling: Best practices for handling API responses
- Rate limiting: this API has no request-quota system — velocity is treated as a fraud signal instead
API Capabilities
The risk validation API analyzes requests and returns:
- Request ID: Unique identifier for tracking and debugging (UUID format)
- Decision: Recommended decision (log, allow, challenge, review, block)
- Risk Score: Numerical score (0-100) indicating threat level
- Risk Level: Categorized assessment (low, medium, high, critical)
Quick Start
Every integration needs both sides — pick your client and pair it with the server API:
- Where to Integrate - Map your user flows (sign-in, registration, checkout…) to Mubeen event types
- Client-Side Integration - Collects the device ID in the browser (also available for Android and iOS)
- Server-Side Integration - Required for every integration: takes the device ID and returns a risk decision
Prerequisites
Before you begin, ensure you have:
- API credentials (API key or access token)
- Base URL for the API endpoint
- Understanding of your application's security requirements