Skip to main content

Advanced Implementation

The following are optional implementation steps that can be taken to optimize the branding, streamline the end customer experience, and provide access to richer functionality.

Performing prequalification checks

By creating a prospect resource, you can run a pre-qualification check to determine if an end customer meets minimum eligibility requirements to apply for capital. A customer's eligibility is based on the business information attributes listed below.

You can choose to perform a prequalification check with business identity or perform an anonymous check.

  • Performing an anonymous check: Omit business information such as businessName and businessContact, and only pass a jwtSubject as a unique identifier for the end customer on your side.
  • Performing a check with business identity: Pass businessName and businessContact along with a jwtSubject to identify the end customer.

Create Prospect

VerbPOST
URLhttps://api.s.unit.sh/capital/prospects
Data Typeprospect
Timeout (Seconds)5

Attributes

prospectType
string
Type of prospect. Currently only Business is supported.
idempotencyKey
string
Unique key to ensure idempotent requests.
jwtSubject
string
Unique identifier for the end customer on your side.
businessNameOptional
string
Optional. Name of the business.
businessContactOptional
Optional. Primary contact of the business.
businessProfile
Business profile information containing business details.
businessFinancials
Business financial information. At least one of salesVolume or averageMonthlyRevenue must be provided.
tags
object
See Tags.

Business Profile

dateOfIncorporation
RFC3339 Date string
Date of incorporation of the business (e.g. 2001-08-10).
dateOfBirth
RFC3339 Date string
Date of birth of the applicant, must be over 18 (e.g. 2001-08-15).
naicsCode
string
businessStructure
string
One of LLC, Sole Proprietor, S Corporation, C Corporation.
businessAddress
Address of the business. Must be a US address.

Business Financials

averageMonthlyRevenueOptional
integer
Optional. Average monthly revenue (in cents).
salesVolumeOptional
Array of Sales Volume
Optional. Array of sales volume entries.
creditScoreOptional
integer
Optional. Applicant Fico's score.

Sales Volume

date
RFC3339 Date string
Date of the sales volume entry (e.g. 2026-01-15).
category
string
Category of the sales volume entry. One of Charge, Refund.
gross
integer
Gross amount (in cents) for the sales volume entry.
count
integer
Number of transactions for the sales volume entry.
Example Request:
curl -X POST 'https://api.s.unit.sh/capital/prospects'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
"data": {
"type": "prospect",
"attributes": {
"prospectType": "Business",
"idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8",
"jwtSubject": "2ab1f266-04b9-41fb-b728-cd1962bca52c",
"businessName": "Pied Piper",
"businessContact": {
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"email": "richard@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "5555555555"
}
},
"businessProfile": {
"dateOfIncorporation": "2001-08-10",
"dateOfBirth": "2001-08-15",
"naicsCode": "541511",
"businessStructure": "LLC",
"businessAddress": {
"street": "5230 Newell Rd",
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
}
},
"businessFinancials": {
"averageMonthlyRevenue": 5000000,
"salesVolume": [
{
"date": "2026-01-15",
"category": "Charge",
"gross": 1500000,
"count": 10
},
{
"date": "2026-01-20",
"category": "Refund",
"gross": 100000,
"count": 2
}
],
"creditScore": 750
}
}
}
}'

Response

Response is a JSON:API document.

201 Created

Prospect is a JSON:API resource, top-level fields:

id
string
Identifier of the prospect resource.
type
string
Type of the prospect resource.
attributes
JSON Object
JSON object representing the prospect data.

Attributes

createdAt
RFC3339 Date string
The date the resource was created (e.g. 2022-02-23T12:15:47.386Z).
prospectType
string
Type of prospect. Currently only Business is supported.
businessNameOptional
string
Optional. Name of the business.
businessContactOptional
Optional. Primary contact of the business.
businessProfile
Business profile information containing business details.
businessFinancials
Business financial information.
tags
object
See Tags.
Example response:
{
"data": {
"type": "prospect",
"id": "7345432",
"attributes": {
"createdAt": "2022-02-23T12:15:47.386Z",
"prospectType": "Business",
"businessName": "Pied Piper",
"businessContact": {
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"email": "richard@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "5555555555"
}
},
"businessProfile": {
"dateOfIncorporation": "2001-08-10",
"dateOfBirth": "2001-08-15",
"naicsCode": "541511",
"businessStructure": "LLC",
"businessAddress": {
"street": "5230 Newell Rd",
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
}
},
"businessFinancials": {
"averageMonthlyRevenue": 5000000,
"salesVolume": [
{
"date": "2026-01-15",
"category": "Charge",
"gross": 1500000,
"count": 10
},
{
"date": "2026-01-20",
"category": "Refund",
"gross": 100000,
"count": 2
}
],
"creditScore": 750
}
}
}
}

Embedding prequalification banner

5 minutes

The prequalification banner allows you to advertise a tailored pre-qualified capital offer to your customer and invite them to complete an application for capital. You can choose to embed the prequalification component anywhere inside your app. Doing so at key decision points, when you expect a customer may be looking for financing, can meaningfully drive capital product adoption.

The prequalification banner is an embedded component that interacts with the prequalification resource. You must perform a prequalification check via API before you can display a prequalified offer to the customer. If you have not performed a prequalification check via API, if you have performed a check but a customer was not prequalified for capital, or if the customer's prequalification offer has expired, the prequalification banner will show nothing and will not occupy any space in your interface. By hitting the apply button in the component, the customer will be redirected to the Ready-to-Launch capital app, where they can complete the application process.

To embed the prequalification banner in your interface, paste the code below to the new page.

<unit-elements-capital-prequalification jwt-token="demo.jwt.token"></unit-elements-capital-prequalification>

Note demo.jwt.token is a real value you can use to preview the component without any setup.

Pre filling end-user information

1-2 days

If you have access to end customer information that you can share in order to streamline their onboarding and reduce the friction of submitting an application for capital, we allow you to provide it and we will use it to pre-fill the end customer’s application form. To support that, you will have to expose an API endpoint that Unit will call when seeing an end user (identified by their JWT subject) for the first time.

Unit will make an HTTP request to this endpoint with a JWT token associated with this user in the Authorization header before initiating the end customer application process. The server will need to return the End User Configuration resource. The response must include the data, type: whiteLabelAppEndUserConfig and attributes keys.

Please contact Unit in order to configure the endpoint.

Request example:

curl -X GET 'https://yourdomain.com/unit/application-form-prefill' \
-H "Authorization: Bearer ${JWT Token}"