API Documentation

Fraud v2.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Fraud API is a service which allows subscribers to make a request to Pixalate's servers to retrieve the probability (risk score) and determine if a user's IP, DeviceID or User Agent is compromised or performing a malicious activity.

Base URLs:

Email: Pixalate, Inc. Web: Pixalate, Inc.

Authentication

  • API Key (ApiKey)
    • Parameter Name: x-api-key, in: header. Authentication and authorization is achieved by supplying your Pixalate provided API key in the header of the request. An API key may be obtained by signing up for an account on the Pixalate developer website.

Default

/fraud

Code samples

# You can also use wget
curl -X GET https://api.pixalate.com/api/v2/fraud \
  -H 'Accept: application/json' \
  -H 'x-api-key: API_KEY'

GET /fraud

Retrive probability of fraud for a specific IP, Device, or Agent. Similar to Pixalate's Blocking Lists, the Fraud Blocking API returns a probability (risk score) 0.01 to 1.0 that represents the likelihood a given value is related to malicious or compromised devices. This risk scoring is calculated by Pixalate’s proprietary machine learning algorithm and allows clients to set their own blocking thresholds based on the quality and scale of their supply inventory. The following is a generic guideline for setting fraud blocking thresholds:

  • Probability equal to 1.0, for filtering out only the worst offender for blocking (deterministic).
  • Probability greater than or equal to 0.90 for filtering out users that are fraudulent beyond reasonable doubt.
  • Probability between 0.75 (inclusive) and 0.90 (exclusive), to filter out users that are associated with clear and convincing evidence that they are fraudulent.
  • Probability between 0.5 (inclusive) and 0.75 (exclusive), to filter out users that it is more likely than not that they are fraudulent (also known as preponderance of the evidence standard).

Pixalate does not recommend blocking any probabilities less than 0.5. When making adjustments to the probability threshold, Pixalate highly recommends regular checks-and-balances against impression delivery as lowering the probabilistic threshold can potentially impact the impression count.

One or more of the following parameters may be provided. If more than one parameter is specified, the probability returned is determined by an assessment of risk based off the combination of each parameter’s individual risk probability.

Parameters

Name In Type Required Description
ip query string false The internet protocol address.
deviceId query string false An ID that characterizes a mobile device. This is the actual mobile identifier. Various types are acceptable as follows:

ID Type NameOperating SystemID LengthDescriptionExample
ADIDAndroid36Google advertising IDFF67345D-BF11-7823-1111-FFED421776FC
IDFAiOS36Apple advertising IDA217D9FC-C1BE-4BEF-94CD-1EE82147C1AA
MD5Multiple32The MD5 hash of a hardware device identifier (e.g. MAC address, IMEI, or advertising ID).d9527b5207097c5770ca448322489426
SHA1Multiple40The SHA-1 hash of a hardware device identifier (e.g. MAC address, IMEI, or advertising ID).2971074629cc8f33146c5eb08b39f157da5ce356
WAIDWindows36Windows advertising ID97615775-57b5-4300-90b4-ba0c22b60e34
RIDARoku OS36Roku’s privacy-friendly device ID331319d2-4cc2-51ac-de21-aa62f1e143c1
MSAIXbox36Advertising ID for Microsoft's Xboxbc23c3de-5d32-4d0c-de3a-94ce878a0379
userAgent query string false The browser or device supplied agent string.

Example responses

200 Response

{
  "probability": 0.6
}

Responses

Status Meaning Description Schema
200 OK OK FraudInfo
400 Bad Request Bad Request - Invalid ip, deviceId, or userAgent. None
401 Unauthorized Unauthorized - Invalid API Key. None
403 Forbidden Forbidden - Rate plan expired or quota has been exhausted. None
5XX Unknown Server Error - The API experienced an internal error. Contact support. None

Schemas

FraudInfo

{
  "probability": 0.6
}

Fraud information

Properties

Name Type Required Restrictions Description
probability number false none The probability of fraud (0.1 through 1.0). 0.0 indicates unknown.