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 prequalification 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
andbusinessContact
, and only pass anexternalId
as a unique identifier for the end customer on your side as a special tag. - Performing a check with business identity: Pass
businessName
andbusinessContact
along with anexternalId
as a special tag to identify the end customer.
Create Prequalification
Verb | POST |
URL | https://api.s.unit.sh/prequalifications |
Data Type | prequalification |
Timeout (Seconds) | 5 |
Attributes
Field | type | Description |
---|---|---|
businessName | string | Optional. Name of the business. |
businessContact | BusinessContact | Optional. Primary contact of the business. |
businessStructure | string | One of LLC , Sole Proprietor , S Corporation , C Corporation . |
businessAddress | Address | Address of the business. Must be a US address |
naicsCode | string | 6 digits business NAICS code, see https://www.census.gov/naics/2022NAICS/6-digit_2022_Codes.xlsx |
dateOfIncorporation | RFC3339 Date string | Date of incorporation of the business. |
averageMonthlyRevenue | integer | Average monthly revenue (in cents). |
dateOfBirth | RFC3339 Date string | Date of birth of the applicant, must be over 18. |
creditScore | integer | Optional. Applicant Fico's score. |
requestedLoanAmount | integer | Optional. Requested loan amount (in cents). |
tags | object | See Tags. |
curl -X POST 'https://api.s.unit.sh/capital/prequalifications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
"data": {
"type": "prequalification",
"attributes": {
"naicsCode": "112310",
"businessStructure": "LLC",
"businessAddress": {
"street": "20 Ingram St",
"city": "Forest Hills",
"state": "NY",
"postalCode": "11375",
"country": "US"
},
"dateOfIncorporation": "2001-08-10",
"averageMonthlyRevenue": "870000",
"dateOfBirth": "2001-08-10",
"creditScore": "700",
"requestedLoanAmount": 13000000,
"tags": {
"externalId": "2ab1f266-04b9-41fb-b728-cd1962bca52c"
}
}
}
}'
Response
Response is a JSON:API document.
201 Created
Prequalification is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the prequalification resource. |
type | string | Type of the prequalification resource. |
attributes | JSON Object | JSON object representing the prequalification data. |
Attributes
Field | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
amount | integer | The prequalified amount (in cents). |
expiredAt | RFC3339 Date string | Date only (e.g. "2001-08-15" ). |
status | string | One of Rejected , Prequalified , Expired . |
tags | object | See Tags. |
{
"data": {
"type": "prequalification",
"id": "7345432",
"attributes": {
"createdAt": "2022-02-23T12:15:47.386Z",
"amount": 12000000,
"expiredAt": "2025-03-20",
"status": "Prequalified",
"tags": {
"externalId": "2ab1f266-04b9-41fb-b728-cd1962bca52c"
}
}
}
}
Embedding prequalification banner
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
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}"