Send feedbacks about verifications - Prelude Documentation

Send feedbacks

curl --request POST \
  --url https://api.prelude.dev/v2/watch/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedbacks": [
    {
      "target": {
        "type": "phone_number",
        "value": "<string>"
      },
      "type": "verification.started",
      "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>"
      }
    }
  ]
}
'

{
  "status": "success",
  "request_id": "<string>"
}

POST

watch

feedback

Send feedbacks

curl --request POST \
  --url https://api.prelude.dev/v2/watch/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedbacks": [
    {
      "target": {
        "type": "phone_number",
        "value": "<string>"
      },
      "type": "verification.started",
      "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>"
      }
    }
  ]
}
'

{
  "status": "success",
  "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

feedbacks

object[]

required

A list of feedbacks to send.

Show child attributes

feedbacks.target

object

required

The feedback target. Only supports phone numbers for now.

Show child attributes

feedbacks.target.type

enum<string>

required

The type of the target. Either "phone_number" or "email_address".

Available options:

phone_number,

email_address

feedbacks.target.value

string

required

An E.164 formatted phone number or an email address.

feedbacks.type

enum<string>

required

The type of feedback.

Available options:

verification.started,

verification.completed

feedbacks.signals

object

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

Show child attributes

feedbacks.signals.ip

string<ipv4>

The IP address of the user's device.

feedbacks.signals.device_id

string

The unique identifier for the user's device. For Android, this corresponds to the ANDROID_ID and for iOS, this corresponds to the identifierForVendor.

feedbacks.signals.device_platform

enum<string>

The type of the user's device.

Available options:

android,

ios,

ipados,

tvos,

web

feedbacks.signals.device_model

string

The model of the user's device.

feedbacks.signals.os_version

string

The version of the user's device operating system.

feedbacks.signals.app_version

string

The version of your application.

feedbacks.signals.user_agent

string

The user agent of the user's device. If the individual fields (os_version, device_platform, device_model) are provided, we will prioritize those values instead of parsing them from the user agent string.

feedbacks.signals.ja4_fingerprint

string

The JA4 fingerprint observed for the connection. Prelude will infer it automatically when requests go through our client SDK (which uses Prelude's edge), but you can also provide it explicitly if you terminate TLS yourself.

feedbacks.signals.is_trusted_user

boolean

This signal should provide a higher level of trust, indicating that the user is genuine. Contact us to discuss your use case. For more details, refer to Signals.

feedbacks.dispatch_id

string

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

Required string length: 36

feedbacks.metadata

object

The metadata for this feedback.

Show child attributes

feedbacks.metadata.correlation_id

string

A user-defined identifier to correlate this feedback with. It is returned in the response and any webhook events that refer to this feedback.

Maximum string length: 80

Response

status

enum<string>

required

The status of the feedbacks sending.

Available options:

success

request_id

string

required

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

Predict the outcome of a verification

Dispatch real-time events

⌘I

Documentation

API Reference

Authorizations

Body

Response