Score Reports#

A Score Report contains the completed scoring results, including individual scores, risk indicators, adverse action codes, and detailed attributes derived from the tenant's financial data.

The Score Report object#

Attribute	Type	Description
`id`	string	Unique identifier with `scrpt_` prefix
`object`	string	Always `"score_report"`
`score_request`	string	Linked Score Request ID
`scores`	array	Array of score results
`scores[].score_type`	string	Type of score
`scores[].value`	integer	Score value (0–100)
`scores[].score_version`	string	Algorithm version used
`scores[].risk_indicator`	enum	`low_risk`, `medium_risk`, `high_risk`
`scores[].adverse_action_codes`	array	Regulatory compliance codes
`attributes`	array	Detailed financial attributes
`attributes[].name`	string	Attribute name
`attributes[].description`	string	Human-readable description
`attributes[].node`	enum	`ASSETS`, `EXPENSES`, `INCOME`
`attributes[].value`	number	Attribute value
`created`	timestamp	Time at which the object was created

{
  "id": "scrpt_xyz789",
  "object": "score_report",
  "score_request": "sr_abc123def456",
  "scores": [
    {
      "score_type": "tenant_score",
      "value": 82,
      "score_version": "v2.1",
      "risk_indicator": "low_risk",
      "adverse_action_codes": []
    },
    {
      "score_type": "cash_flow_score",
      "value": 78,
      "score_version": "v1.3",
      "risk_indicator": "low_risk",
      "adverse_action_codes": []
    },
    {
      "score_type": "credit_score",
      "value": 65,
      "score_version": "v1.0",
      "risk_indicator": "medium_risk",
      "adverse_action_codes": [
        {
          "code": "AC-201",
          "description": "Limited credit history length"
        },
        {
          "code": "AC-305",
          "description": "High credit utilization ratio"
        }
      ]
    }
  ],
  "attributes": [
    { "name": "monthly_income", "description": "Average monthly income", "node": "INCOME", "value": 600000 },
    { "name": "monthly_expenses", "description": "Average monthly expenses", "node": "EXPENSES", "value": 420000 },
    { "name": "net_monthly_cash_flow", "description": "Net monthly cash flow", "node": "ASSETS", "value": 180000 },
    { "name": "rent_to_income_ratio", "description": "Proposed rent as ratio of income", "node": "INCOME", "value": 0.28 },
    { "name": "savings_balance", "description": "Current savings balance", "node": "ASSETS", "value": 1500000 },
    { "name": "debt_to_income_ratio", "description": "Total debt payments as ratio of income", "node": "EXPENSES", "value": 0.12 },
    { "name": "income_stability_score", "description": "Income consistency over 12 months", "node": "INCOME", "value": 0.94 },
    { "name": "expense_volatility", "description": "Expense variation coefficient", "node": "EXPENSES", "value": 0.15 }
  ],
  "created": 1706140800
}

Retrieve a Score Report#

GET /v1/score_reports/:id

curl https://api.casapay.com/v1/score_reports/scrpt_xyz789 \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

List Score Reports#

GET /v1/score_reports

Parameter	Type	Description
`score_request`	string	Filter by Score Request ID
`limit`	integer	Number of objects to return (1–100)
`starting_after`	string	Cursor for pagination

curl https://api.casapay.com/v1/score_reports?limit=10 \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"