Send feedbacks about verifications
Send feedback regarding your end-users verification funnel. Events will be analyzed for proactive fraud prevention and risk scoring.
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": "+30123456789"
},
"type": "verification.started",
"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>"
}
}
]
}'
{
"status": "success",
"request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
A list of feedbacks to send.
The feedback target. Only supports phone numbers for now.
The type of feedback.
verification.started
, verification.completed
The signals used for anti-fraud. For more details, refer to Signals.
The IP address of the user's device.
"192.0.2.1"
The unique identifier for the user's device. For Android, this corresponds to the ANDROID_ID
and for iOS, this corresponds to the identifierForVendor
.
"8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2"
The type of the user's device.
android
, ios
, ipados
, tvos
, web
"ios"
The model of the user's device.
"iPhone17,2"
The version of the user's device operating system.
"18.0.1"
The version of your application.
"1.2.34"
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.
"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"
The identifier of the dispatch that came from the front-end SDK.
Response
The status of the feedbacks sending.
success
"success"
A string that identifies this specific request. Report it back to us to help us diagnose your issues.
"3d19215e-2991-4a05-a41a-527314e6ff6a"
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": "+30123456789"
},
"type": "verification.started",
"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>"
}
}
]
}'
{
"status": "success",
"request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a"
}