Customers

Get the latest evaluation for a customer

Returns the latest completed evaluation for the customer. Its product decides what is returned: ATTRIBUTES returns attributes, monthly financials, and recurring cash flows with a null slope_score; SCORE returns only slope_score (score and reasons); ATTRIBUTES_AND_SCORE returns both.

get/api/v1/customers/{customer_id}/evaluate

Request

  • Base URL
    https://slopeai.slopepay.com
  • URL
    https://slopeai.slopepay.com/api/v1/customers/{customer_id}/evaluate
  • Auth
    HTTP bearer

Path parameters

customer_idstring required

Customer identifier

Example:cust_12345

Response

Latest evaluation for the customer

idstring required
customer_idstring required
as_ofstring date-time required

Timestamp at which this evaluation was computed

data_window_startstring nullable required

Start date of the data window used for evaluation

data_window_endstring nullable required

End date of the data window used for evaluation

model_versionstring nullable required

Version of the evaluation model used

features_versionstring nullable required

Version of the features schema

product'ATTRIBUTES' | 'SCORE' | 'ATTRIBUTES_AND_SCORE' required

The product this evaluation was requested with; it decides which of the fields below are returned

featuresobject nullable required

Cash flow attributes used for evaluation. Null when product is SCORE.

Example response

{
  "id": "eval_001",
  "customer_id": "cust_12345",
  "data_window_start": "2025-01-01",
  "data_window_end": "2026-01-01",
  "model_version": "v1.0",
  "features_version": "v2.0",
  "slope_score": {
    "score": 750,
    "version": "v1.0",
    "reasons": [
      {
        "code": "LOW_BALANCE",
        "description": "Average balance is below threshold"
      }
    ]
  },
  "financials": [
    {
      "month": "2026-01"
    }
  ],
  "recurring_cashflows": [
    {
      "start_date": "2025-01-01",
      "end_date": "2026-01-01"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.