---
title: "Create a prescreen"
method: POST
path: "/v4/prescreens"
tags: ["Prescreens"]
---

# Create a prescreen

`POST /v4/prescreens`

## Request body

- CreatePrescreenV4RequestDto
  - `externalId` string, required — The partner's unique ID of the customer
  - `annualRevenueAmount` number, required — Last 12 months revenue, in cents
  - `businessName` string, required — The name of the business
  - `doingBusinessAs` string — The customer's doing business as (DBA) name
  - `address` AddressSharedDto, required
    - `line1` string, required — The first line of the address
    - `line2` string
    - `city` string, required
    - `country` string, required — ISO31661 Alpha2 code for the country
    - `state` string, required — 2-letter US state abbreviation
    - `postalCode` string, required — 5-digit US postal code
  - `email` string, required — The email address of the business
  - `taxId` string — The US Tax ID of the business (optional)
  - `website` string — The website of the business. If provided, must begin with http:// or https://
  - `phone` string — The phone number of the business
  - `entityType` 'LLC' | 'S Corp' | 'Corporation' | 'Partnership' | 'Sole Proprietorship'
  - `desiredLimit` number — The desired funding limit for the customer, in cents.
  - `metadata` PrescreenMetadataSharedDto
    - `yearEstablished` number — Year of establishment of business
    - `expectedMonthlySpendingCents` number — Expected monthly spending in cents
    - `joinDateRangeDays` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `lastTransactionAmountRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `lastTransactionDateRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `totalSpending90DaysRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `totalSpending365DaysRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `totalPurchases90DaysRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `totalPurchases365DaysRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `growthLevel` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `smbNotVerified` boolean — SMB not verified status
    - `highValueCustomer` boolean — High value customer status
    - `purchasingDemandForecast6MonthsCents` number — Purchasing demand forecast for the next 6 months in cents
    - `buyerRiskLevelRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `buyerStickinessRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `buyerPurchasingStabilityRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `avgPurchaseIntervals365Range` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `avgPurchaseIntervals730Range` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `coefficientPurchaseIntervals365Range` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `coefficientPurchaseIntervals730Range` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `externalTransactionId` string — The partner's transaction ID used to tie a prescreen to a specific transaction
    - `purchasingDemandFor6m` string — A temporary field in order to bypass field validation. This field is expected to be removed.

## Response `200`

The created prescreen.

- PrescreenEntityV4ResponseDto
  - `id` string, required — ID of the prescreen
  - `customerId` string, required — Slope Customer ID
  - `status` 'pending' | 'succeeded' | 'failed', required — Status of the prescreen
  - `approvalLikelihood` string — Likelihood of approval: high, med, low
  - `limitCents` number — Evaluated limit of the prescreen, in cents
  - `bestAprPct` number — Best APR percentage, e.g 12.99
  - `reasons` PrescreenSharedDto[] — Reasons for the prescreen results
    - `code` string, required — The code of the reason
    - `message` string, required — The message of the reason
  - `expiresAt` string, date-time — When the prescreen expires, e.g 2025-01-01T00:00:00.000Z
  - `metadata` PrescreenMetadataSharedDto
    - `yearEstablished` number — Year of establishment of business
    - `expectedMonthlySpendingCents` number — Expected monthly spending in cents
    - `joinDateRangeDays` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `lastTransactionAmountRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `lastTransactionDateRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `totalSpending90DaysRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `totalSpending365DaysRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `totalPurchases90DaysRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `totalPurchases365DaysRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `growthLevel` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `smbNotVerified` boolean — SMB not verified status
    - `highValueCustomer` boolean — High value customer status
    - `purchasingDemandForecast6MonthsCents` number — Purchasing demand forecast for the next 6 months in cents
    - `buyerRiskLevelRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `buyerStickinessRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `buyerPurchasingStabilityRange` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `avgPurchaseIntervals365Range` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `avgPurchaseIntervals730Range` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `coefficientPurchaseIntervals365Range` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `coefficientPurchaseIntervals730Range` 'NA' | 'L0' | 'L1' | 'L2' | 'L3' | 'L4' | 'L5' | 'L6' | 'L7' | 'L8' | 'L9' | 'L10' | 'L11' — Join date range level
    - `externalTransactionId` string — The partner's transaction ID used to tie a prescreen to a specific transaction
    - `purchasingDemandFor6m` string — A temporary field in order to bypass field validation. This field is expected to be removed.

## Other responses

- `400` — Returned when improperly formatted or missing fields in request body
- `401` — Returned when improper keys or headers are used in the request
- `403` — Returned when the caller is not authorized to access the resource
- `409` — Conflict - Request conflicts with current state of the resource
- `500` — Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.net/slopepay/apis/slope-v4-api.md) · [All operations](https://skmtc.net/slopepay/apis/slope-v4-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/slopepay/slope-v4-api/versions/cbdbc861073b/schema)