POST
/
v2
/
watch
/
predict
curl --request POST \
  --url https://api.prelude.dev/v2/watch/predict \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "target": {
    "type": "phone_number",
    "value": "+30123456789"
  },
  "signals": {
    "ip": "192.0.2.1",
    "device_id": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2",
    "device_platform": "ios",
    "device_model": "iPhone17,2",
    "os_version": "18.0.1",
    "app_version": "1.2.34",
    "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Mobile/15E148 Safari/604.1",
    "is_trusted_user": false
  },
  "dispatch_id": "<string>",
  "metadata": {
    "correlation_id": "<string>"
  }
}'
{
  "id": "prd_01jc0t6fwwfgfsq1md24mhyztj",
  "prediction": "legitimate",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
target
object
required

The prediction target. Only supports phone numbers for now.

​
signals
object

The signals used for anti-fraud. For more details, refer to Signals.

​
dispatch_id
string

The identifier of the dispatch that came from the front-end SDK.

​
metadata
object

The metadata for this prediction.

Response

200
application/json
OK
​
id
string
required

The prediction identifier.

Example:

"prd_01jc0t6fwwfgfsq1md24mhyztj"

​
prediction
enum<string>
required

The prediction outcome.

Available options:
legitimate,
suspicious
​
request_id
string
required

A string that identifies this specific request. Report it back to us to help us diagnose your issues.

Example:

"3d19215e-2991-4a05-a41a-527314e6ff6a"