Skip to main content
POST
/
v2
/
watch
/
predict
Predict outcome
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": "<string>"
  },
  "signals": {
    "ip": "127.0.0.1",
    "device_id": "<string>",
    "device_platform": "android",
    "device_model": "<string>",
    "os_version": "<string>",
    "app_version": "<string>",
    "user_agent": "<string>",
    "ja4_fingerprint": "<string>",
    "is_trusted_user": true
  },
  "dispatch_id": "<string>",
  "metadata": {
    "correlation_id": "<string>"
  }
}
'
{
  "id": "<string>",
  "prediction": "legitimate",
  "request_id": "<string>"
}

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.

Required string length: 36
​
metadata
object

The metadata for this prediction.

Response

OK

​
id
string
required

The prediction identifier.

​
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.