Guarantee Policies#

Guarantee Policies define the terms and conditions for rent guarantees, including coverage percentages, waiting periods, and eligibility criteria.

The Guarantee Policy object#

Attribute	Type	Description
`id`	string	Unique identifier with `gpol_` prefix
`object`	string	Always `"guarantee_policy"`
`name`	string	Policy name
`coverage_percentage`	integer	Percentage of rent covered (1–100)
`max_coverage_months`	integer	Maximum months of coverage
`waiting_period_days`	integer	Days before coverage starts
`eligible_score_minimum`	integer	Minimum tenant score for eligibility
`deductible_amount`	integer	Deductible per claim
`active`	boolean	Whether the policy is active
`metadata`	hash	Key-value pairs
`created`	timestamp	Time at which the object was created

{
  "id": "gpol_abc123",
  "object": "guarantee_policy",
  "name": "Standard Rent Guarantee",
  "coverage_percentage": 100,
  "max_coverage_months": 12,
  "waiting_period_days": 30,
  "eligible_score_minimum": 60,
  "deductible_amount": 0,
  "active": true,
  "created": 1706140800
}

Create, Retrieve, Update, List#

POST /v1/guarantee_policies

GET /v1/guarantee_policies/:id

POST /v1/guarantee_policies/:id

GET /v1/guarantee_policies

curl https://api.casapay.com/v1/guarantee_policies \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Premium Guarantee",
    "coverage_percentage": 100,
    "max_coverage_months": 24,
    "waiting_period_days": 14,
    "eligible_score_minimum": 50
  }'