v1

latestOpenAPI 3.0.02026-07-244074117.0 KB

Prescreens

Get prescreens by customer ID

Get all prescreens by customer ID, most recent prescreen first.

get/v4/prescreens

Query parameters

customerIdstring required

Example:partner-customer-1234

The customer ID to get prescreens for. The external customer ID is also accepted.

Response

The prescreens for the customer

Example response

{
  "prescreens": [
    {
      "id": "prescreen_xyz789",
      "customerId": "cust_def456",
      "status": "succeeded",
      "approvalLikelihood": "high",
      "limitCents": 500000,
      "bestAprPct": 15.99,
      "reasons": [
        {
          "code": "good_credit_history",
          "description": "Customer has a strong credit history."
        }
      ],
      "expiresAt": "2024-12-31T23:59:59.000Z"
    },
    {
      "id": "prescreen_uvw456",
      "customerId": "cust_def456",
      "status": "pending",
      "approvalLikelihood": null,
      "limitCents": null,
      "bestAprPct": null,
      "reasons": [],
      "expiresAt": null
    }
  ]
}