v1

latestOpenAPI 3.0.02026-07-244074117.0 KB

Prescreens

Get a prescreen

Get a specific prescreen by ID.

get/v4/prescreens/{id}

Path parameters

idstring required

The prescreen ID.

Response

The prescreen

idstring required

ID of the prescreen

customerIdstring required

Slope Customer ID

status'pending' | 'succeeded' | 'failed' required

Status of the prescreen

approvalLikelihoodstring

Likelihood of approval: high, med, low

limitCentsnumber

Evaluated limit of the prescreen, in cents

bestAprPctnumber

Best APR percentage, e.g 12.99

expiresAtstring date-time

When the prescreen expires, e.g 2025-01-01T00:00:00.000Z

Example response

{
  "id": "prescreen_123",
  "customerId": "customer_123",
  "approvalLikelihood": "high",
  "limitCents": 100000,
  "bestAprPct": 12.99,
  "reasons": [
    {
      "code": "unmatched-kyb",
      "message": "KYB datat mismatch"
    }
  ],
  "expiresAt": "2025-01-01T00:00:00.000Z",
  "metadata": {
    "yearEstablished": 2015,
    "expectedMonthlySpendingCents": 50000,
    "smbNotVerified": true,
    "purchasingDemandForecast6MonthsCents": 180000,
    "externalTransactionId": "1234567890",
    "purchasingDemandFor6m": "C"
  }
}