SLslopepay
Evaluate

Evaluate one customer synchronously

Stores the customer's accounts, balances, and transactions (same as POST /batch), then runs enrichment and evaluation inline and returns the evaluation. The evaluation uses the customer's full stored history, not only the transactions in this request. If it does not finish within 55 seconds, returns 504 EVALUATION_TIMEOUT with a job_id while processing continues; retry with the same Idempotency-Key to get the result.

post/api/v1/evaluate

Request

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

Headers

Idempotency-Keystring

Optional idempotency key for safely retrying an evaluation. Reusing the same key with an identical request body returns the original evaluation (or EVALUATION_IN_PROGRESS while it is still running) without re-running it; reusing it with a different body returns IDEMPOTENCY_MISMATCH (400). Keys expire after a TTL.

Example:evaluate-cust_12345-2026-01-01

Request body

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

What an EVALUATE returns: cash flow attributes (features, monthly financials, and recurring cash flows), the Slope Score with its reasons, or both

Example request

{
  "customer": {
    "customer_id": "cust_12345",
    "first_name": "John",
    "last_name": "Doe",
    "business_name": "Acme Corp"
  },
  "accounts": [
    {
      "account_id": "acc_001",
      "number_mask": "1234",
      "name": "Checking"
    }
  ],
  "balances": [
    {
      "account_id": "acc_001",
      "date": "2026-01-01T00:00:00Z",
      "current": 100000,
      "available": 95000,
      "currency": "usd"
    }
  ],
  "transactions": [
    {
      "transaction_id": "txn_001",
      "account_id": "acc_001",
      "description": "ACME CORP PAYMENT",
      "amount": -50000,
      "date": "2026-01-15T00:00:00Z",
      "authorized_date": "2026-01-14T00:00:00Z",
      "currency": "usd"
    }
  ]
}

Response

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.

job_idstring required

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"
    }
  ],
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

Changes

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