Ban insurance
The project insurance evidence object
Attributes
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
enabledbooleanrequiredWhether this feature is enabled.
banInsuranceIncludedbooleanrequiredWhether ban insurance included.
{
"projectId": "00000000-0000-4000-8000-000000000000",
"enabled": true,
"banInsuranceIncluded": true
}Get project insurance evidence
- Base URL
https://api.polymorfa.com- Required permission
sessions:read
Ban Credit evidence lets Polymorfa measure what the other devices linked to a number do with it: how many messages they send, to how many people, how fast, and in which hours. Only counts are kept, never messages, contacts, or device names. With it off, a claim can still be filed, but Polymorfa cannot say whether another device caused the ban and a person decides the claim.
Path parameters
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
Responses
200The project's Ban Credit evidence setting
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 3 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl "https://api.polymorfa.com/messaging/projects/<projectId>/insurance-evidence" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"projectId": "00000000-0000-4000-8000-000000000000",
"enabled": true,
"banInsuranceIncluded": true
}
}Update project insurance evidence
- Base URL
https://api.polymorfa.com- Required permission
sessions:manage
Ban Credit evidence lets Polymorfa measure what the other devices linked to a number do with it: how many messages they send, to how many people, how fast, and in which hours. Only counts are kept, never messages, contacts, or device names. With it off, a claim can still be filed, but Polymorfa cannot say whether another device caused the ban and a person decides the claim.
Path parameters
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
Body
enabledbooleanrequiredWhether this feature is enabled.
Responses
200The project's Ban Credit evidence setting was updated
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 3 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
503Stored, but a connected number did not confirm the change; retry the request
curl -X PUT "https://api.polymorfa.com/messaging/projects/<projectId>/insurance-evidence" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"enabled": true
}'{
"success": true,
"data": {
"projectId": "00000000-0000-4000-8000-000000000000",
"enabled": true,
"banInsuranceIncluded": true
}
}