v1

latestOpenAPI 3.0.02026-07-244074117.0 KB

Prescreens

Create a prescreen

post/v4/prescreens

Request body

externalIdstring required

The partner's unique ID of the customer

annualRevenueAmountnumber required

Last 12 months revenue, in cents

businessNamestring required

The name of the business

doingBusinessAsstring

The customer's doing business as (DBA) name

emailstring required

The email address of the business

taxIdstring

The US Tax ID of the business (optional)

websitestring

The website of the business. If provided, must begin with http:// or https://

phonestring

The phone number of the business

entityType'LLC' | 'S Corp' | 'Corporation' | 'Partnership' | 'Sole Proprietorship'

desiredLimitnumber

The desired funding limit for the customer, in cents.

Example request

{
  "externalId": "partner-customer-123",
  "annualRevenueAmount": 1000000,
  "businessName": "Acme, Inc.",
  "doingBusinessAs": "Acme Storefront",
  "address": {
    "line1": "123 Main St",
    "city": "San Francisco",
    "country": "US",
    "state": "CA",
    "postalCode": "94107"
  },
  "email": "info@acme.com",
  "taxId": "123456789",
  "website": "https://slopepay.com",
  "phone": "14155551234",
  "desiredLimit": 100000,
  "metadata": {
    "yearEstablished": 2015,
    "expectedMonthlySpendingCents": 50000,
    "smbNotVerified": true,
    "purchasingDemandForecast6MonthsCents": 180000,
    "externalTransactionId": "1234567890",
    "purchasingDemandFor6m": "C"
  }
}

Response

The created 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"
  }
}