Skip to content

Fraud

Retrieves a fraud score for a lead using AI strategy.

Endpoint

bash
POST https://api.example.com/score

Strategy Parameter

The strategy query parameter determines the fraud detection method used to score the lead. It accepts one of three values:

  • rule-based: Uses predefined rules and patterns to detect fraud
  • ai: Uses artificial intelligence and machine learning models to detect fraud
  • hybrid: Combines both rule-based and AI approaches (default)

If the strategy parameter is not specified in the query string, it defaults to hybrid. The strategy affects how the fraud score is calculated and which detection algorithms are applied.

Example:

  • ?strategy=ai - Uses only AI-based detection
  • ?strategy=rule-based - Uses only rule-based detection
  • ?strategy=hybrid - Uses both methods (default)
  • No parameter - Defaults to hybrid

Headers

  • Content-Type: application/json
  • x-api-key: {x-api-key token}

Request Body

json
{
    "name": "test",
    "email": "test",
    "phone": "test",
    "country": "test",
    "ipAddress": "test"
}

Example Request

bash
curl --location 'https://api.example.com/score' \
--header 'x-api-key: {x-api-key token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "test",
    "email": "test",
    "phone": "test",
    "country": "test",
    "ipAddress": "test"
}'

Field Descriptions

FieldTypeDescription
namestringLead's full name
emailstringLead's email address
phonestringLead's phone number
countrystringTwo-letter country code (e.g., "FR" for France)
ipAddressstringLead's IP address

Released under the MIT License.