Introduction
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Welcome to the Kasasa Loans API documentation. This API will give you the ability to submit loan applications and check the status of those applications. All requests must supply the Content-Type: application/json header. Request and response bodies are JSON encoded. Requests must be made over HTTPS. Partners requesting an array of prequalified offers will use the Applications endpoint to create a new application request. The client should then poll for the status of an application using get-status. If qualified, an array of prequalified offers will be returned for the user to select from. For partners that host Kasasa’s underwriting criteria and perform their own soft credit checks, applications should be submitted using the one step submit. The client should then poll for the status of an application using get-status.
Base URLs:
- //kloans-loan-application.k8s.dev.ksops.net/kloans/loan-application
One Step Submit
Code samples
URL obj = new URL("/kloans-loan-application.k8s.dev.ksops.net/kloans/loan-application/channel-partner-applications/one-step-submit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /channel-partner-applications/one-step-submit
Submits a new application, performs a hard credit pull, and returns a qualified or declined response.
Body parameter
{
"loanType": "string",
"loanPurposeType": "string",
"amount": "string",
"fiId": 0,
"applicationLender": "string",
"applicationSource": "string",
"term": 0,
"storeNumber": 0,
"storeName": "string",
"employeeName": "string",
"orderNumber": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "2019-08-24",
"ssn": "string",
"creditScore": "string",
"email": "string",
"phone": "string",
"resType": "string",
"address": "string",
"apt": "string",
"city": "string",
"state": "string",
"zip": "string",
"county": "string",
"addrY": 0,
"addrM": 0,
"housePmt": "string",
"employer": "string",
"empType": "string",
"empTitle": "string",
"empPhone": "string",
"empExt": "string",
"empY": 0,
"empM": 0,
"grossMthInc": "string",
"otherMthInc": "string",
"otherIncType": "string",
"prevEmployer": "string",
"prevEmpType": "string",
"prevEmpTitle": "string",
"prevEmpPhone": "string",
"prevEmpExt": "string",
"prevEmpY": 0,
"prevEmpM": 0,
"prevAddress": "string",
"prevApt": "string",
"prevCity": "string",
"prevState": "string",
"prevZip": "string",
"prevCounty": "string",
"prevAddrY": 0,
"prevAddrM": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OneStepSubmitChannelPartnerApplicationRequest | true | none |
Example responses
200 Response
{
"applicationExternalId": "string",
"consumerExternalId": "string",
"status": "APPROVED"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | SubmitChannelPartnerApplicationResponse |
Application Submit
Overview
The Application Submit API allows you to create and submit an application in a two-step process. Partners using Kasasa to perform a soft credit pull will create an application. The client should then poll for prequalified offers using get-status. If a user selects a prequalified offer, the client should submit the final application for a hard credit pull and decision
Create Channel Partner Application
Code samples
URL obj = new URL("/kloans-loan-application.k8s.dev.ksops.net/kloans/loan-application/channel-partner-applications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /channel-partner-applications
Creates a new channel partner application and initiates a soft credit pull.
Body parameter
{
"loanType": "string",
"loanPurposeType": "string",
"amount": "string",
"applicationSource": "string",
"storeNumber": 0,
"storeName": "string",
"employeeName": "string",
"orderNumber": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "2019-08-24",
"ssn": "string",
"creditScore": "string",
"email": "string",
"phone": "string",
"resType": "string",
"address": "string",
"apt": "string",
"city": "string",
"state": "string",
"zip": "string",
"county": "string",
"addrY": 0,
"addrM": 0,
"housePmt": "string",
"employer": "string",
"empType": "string",
"empTitle": "string",
"empPhone": "string",
"empExt": "string",
"empY": 0,
"empM": 0,
"grossMthInc": "string",
"otherMthInc": "string",
"otherIncType": "string",
"prevEmployer": "string",
"prevEmpType": "string",
"prevEmpTitle": "string",
"prevEmpPhone": "string",
"prevEmpExt": "string",
"prevEmpY": 0,
"prevEmpM": 0,
"prevAddress": "string",
"prevApt": "string",
"prevCity": "string",
"prevState": "string",
"prevZip": "string",
"prevCounty": "string",
"prevAddrY": 0,
"prevAddrM": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateChannelPartnerApplicationRequest | true | none |
Example responses
200 Response
{
"applicationExternalId": "string",
"consumerExternalId": "string",
"status": "APPROVED"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | CreateApplicationResponse |
Submit Channel Partner Application
Code samples
URL obj = new URL("/kloans-loan-application.k8s.dev.ksops.net/kloans/loan-application/channel-partner-applications/submit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /channel-partner-applications/submit
Submits an existing channel partner application.
Body parameter
{
"applicationExternalId": "string",
"term": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SubmitChannelPartnerApplicationRequest | true | none |
Example responses
200 Response
{
"applicationExternalId": "string",
"consumerExternalId": "string",
"status": "APPROVED"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | SubmitChannelPartnerApplicationResponse |
Application Search
Overview
The application search API allows you to retrieve the status and details of a specific application or search for applications.
Get Application Status
Code samples
URL obj = new URL("/kloans-loan-application.k8s.dev.ksops.net/kloans/loan-application/applications/get-status");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /applications/get-status
Returns the status information for the given application external id. If the one step submit is used, offers will contain the firm offer for the term supplied in that request. If create and submit was used, the offers array could contain both prequalified and firm offers depending on the status of the application.
Body parameter
{
"applicationExternalId": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ApplicationExternalIdBody | false | none |
Example responses
200 Response
{
"applicationExternalId": "string",
"status": "APPROVED",
"loanId": "string",
"loanNumber": "string",
"offerType": "FIRM",
"fiId": 0,
"approvedAmount": "string",
"maxApprovedAmount": "string",
"estimatedMonthlyPayment": "string",
"term": 0,
"rate": "string",
"expirationDate": "2019-08-24",
"offers": [
{
"responseId": "string",
"applicationLender": "string",
"creditOfferType": "FIRM",
"fiId": 0,
"isPrequalified": true,
"denialReason": "NO_LENDER_IN_GEO",
"approvedAmount": "string",
"maxApprovedAmount": "string",
"estimatedMonthlyPayment": "string",
"term": 0,
"rate": "string",
"applicationOfferDate": "2019-08-24",
"applicationOfferExpirationDate": "2019-08-24"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | GetApplicationStatusResponse |
Find Application by ID
Code samples
URL obj = new URL("/kloans-loan-application.k8s.dev.ksops.net/kloans/loan-application/applications/find-by-id");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /applications/find-by-id
Returns the application for the given external id.
Body parameter
{
"applicationExternalId": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ApplicationExternalIdBody | false | none |
Example responses
200 Response
{
"applicationExternalId": "string",
"consumerExternalId": "string",
"loanId": "string",
"loanNumber": "string",
"status": "APPROVED",
"applicationSource": "string",
"fiId": 0,
"applicationLender": "string",
"loanPurposeType": "AUTO_REFINANCE",
"amount": "string",
"term": "string",
"loanType": "PERSONAL",
"storeNumber": 0,
"storeName": "string",
"employeeName": "string",
"orderNumber": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "2019-08-24",
"ssnLastFour": "string",
"email": "string",
"phone": "string",
"resType": "BUYING_OR_OWN_WITH_MORTGAGE",
"address": "string",
"apt": "string",
"city": "string",
"state": "string",
"zip": "string",
"county": "string",
"addrY": 0,
"addrM": 0,
"housePmt": "string",
"employer": "string",
"empType": "FULL_TIME",
"empTitle": "string",
"empPhone": "string",
"empExt": "string",
"empY": 0,
"empM": 0,
"empAddress": "string",
"empCity": "string",
"empState": "string",
"empZip": "string",
"grossMthInc": "string",
"otherMthInc": "string",
"otherIncType": "NONE",
"prevEmployer": "string",
"prevEmpType": "FULL_TIME",
"prevEmpTitle": "string",
"prevEmpPhone": "string",
"prevEmpExt": "string",
"prevEmpY": 0,
"prevEmpM": 0,
"make": "string",
"model": "string",
"year": "string",
"bodyStyle": "string",
"mileage": 0,
"vin": "string",
"options": "string",
"curPmt": "string",
"curLien": "string",
"prevAddress": "string",
"prevApt": "string",
"prevCity": "string",
"prevState": "string",
"prevZip": "string",
"prevCounty": "string",
"prevAddrY": 0,
"prevAddrM": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | FindApplicationByIdResponse |
Search Applications
Code samples
URL obj = new URL("/kloans-loan-application.k8s.dev.ksops.net/kloans/loan-application/channel-partner-applications/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /channel-partner-applications/search
Returns a list of applications matching the given parameters
Body parameter
{
"applicationSource": "string",
"storeNumber": 0,
"initialApplicationStatus": "string",
"currentApplicationStatus": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SearchApplicationsRequest | true | none |
Example responses
200 Response
[
{
"applicationExternalId": "string",
"loanId": "string",
"loanNumber": "string",
"firstName": "string",
"lastName": "string",
"ssnLastFour": "string",
"initialStatus": "APPROVED",
"currentStatus": "string",
"submissionDate": "2019-08-24",
"employeeName": "string",
"storeNumber": 0
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | [ApplicationSummary] | false | none |
| » applicationExternalId | string | false | none |
| » loanId | string | false | none |
| » loanNumber | string | false | none |
| » firstName | string | false | none |
| » lastName | string | false | none |
| » ssnLastFour | string | false | none |
| » initialStatus | string | false | none |
| » currentStatus | string | false | none |
| » submissionDate | string(date) | false | none |
| » employeeName | string | false | none |
| » storeNumber | integer(int32) | false | none |
Enumerated Values
| Property | Value |
|---|---|
| initialStatus | APPROVED |
| initialStatus | DECLINED |
| initialStatus | IDV_FAILED |
| initialStatus | IDV_REJECTED |
| initialStatus | IDV_SUCCESS |
| initialStatus | NEW |
| initialStatus | NOT_QUALIFIED |
| initialStatus | PREQUALIFIED |
| initialStatus | RATES_FAILED |
| initialStatus | REFERRED |
| initialStatus | SUBMIT_FAILED |
| initialStatus | SUBMITTED |
Consumers
Overview
The Consumers API allows you to retrieve consumer information for individuals who have created applications.
Get Consumer Data by ID
Code samples
URL obj = new URL("/kloans-loan-application.k8s.dev.ksops.net/kloans/loan-application/consumers/find-by-id");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /consumers/find-by-id
Returns the consumer data including application data for the given external id
Body parameter
{
"consumerExternalId": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ConsumerExternalIdBody | false | none |
Example responses
200 Response
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"phoneNumber": "string",
"emailAddress": "string",
"ssnLastFour": "string",
"birthYear": "string",
"grossMonthlyIncome": "string",
"otherMonthlyIncome": "string",
"otherIncomeType": "NONE",
"currentEmployment": {
"employmentType": "FULL_TIME",
"employer": "string",
"employerPhone": "string",
"jobTitle": "string",
"yearsEmployed": 0,
"monthsEmployed": 0
},
"previousEmployment": {
"employmentType": "FULL_TIME",
"employer": "string",
"employerPhone": "string",
"jobTitle": "string",
"yearsEmployed": 0,
"monthsEmployed": 0
},
"currentAddress": {
"streetAddress1": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"county": "string",
"residenceType": "BUYING_OR_OWN_WITH_MORTGAGE",
"monthlyPayment": "string",
"addressYears": 0,
"addressMonths": 0
},
"previousAddress": {
"streetAddress1": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"county": "string",
"residenceType": "BUYING_OR_OWN_WITH_MORTGAGE",
"monthlyPayment": "string",
"addressYears": 0,
"addressMonths": 0
},
"applications": [
{
"externalId": "string",
"loanType": "PERSONAL",
"loanPurposeType": "AUTO_REFINANCE",
"applicationSource": "string",
"applicationSourceId": "string",
"creditScore": "string",
"status": "APPROVED",
"loanApplicationStatus": "string",
"loanApplicationVendorId": "string",
"loanApplicationSubmissionDate": "2019-08-24",
"loanApplicationExpirationDate": "2019-08-24",
"loanVendorId": "string",
"amountRequested": "string",
"termRequested": 0,
"vehicleLoanDetails": {
"vehicleYear": "string",
"vehicleMake": "string",
"vehicleModel": "string",
"vehicleTrim": "string",
"currentLender": "string",
"currentMonthlyPayment": "string",
"mileage": 0
},
"offers": [
{
"responseId": "string",
"applicationLender": "string",
"creditOfferType": "FIRM",
"fiId": 0,
"isPrequalified": true,
"denialReason": "NO_LENDER_IN_GEO",
"approvedAmount": "string",
"maxApprovedAmount": "string",
"estimatedMonthlyPayment": "string",
"term": 0,
"rate": "string",
"applicationOfferDate": "2019-08-24",
"applicationOfferExpirationDate": "2019-08-24"
}
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | GetConsumerDataResponse |
Schemas
GetApplicationStatusResponse
{
"applicationExternalId": "string",
"status": "APPROVED",
"loanId": "string",
"loanNumber": "string",
"offerType": "FIRM",
"fiId": 0,
"approvedAmount": "string",
"maxApprovedAmount": "string",
"estimatedMonthlyPayment": "string",
"term": 0,
"rate": "string",
"expirationDate": "2019-08-24",
"offers": [
{
"responseId": "string",
"applicationLender": "string",
"creditOfferType": "FIRM",
"fiId": 0,
"isPrequalified": true,
"denialReason": "NO_LENDER_IN_GEO",
"approvedAmount": "string",
"maxApprovedAmount": "string",
"estimatedMonthlyPayment": "string",
"term": 0,
"rate": "string",
"applicationOfferDate": "2019-08-24",
"applicationOfferExpirationDate": "2019-08-24"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| applicationExternalId | string | false | none |
| status | string | false | none |
| loanId | string | false | none |
| loanNumber | string | false | none |
| offerType | string | false | none |
| fiId | integer(int32) | false | none |
| approvedAmount | string | false | none |
| maxApprovedAmount | string | false | none |
| estimatedMonthlyPayment | string | false | none |
| term | integer(int32) | false | none |
| rate | string | false | none |
| expirationDate | string(date) | false | none |
| offers | [Offer] | false | none |
Enumerated Values
| Property | Value |
|---|---|
| status | APPROVED |
| status | DECLINED |
| status | IDV_FAILED |
| status | IDV_REJECTED |
| status | IDV_SUCCESS |
| status | NEW |
| status | NOT_QUALIFIED |
| status | PREQUALIFIED |
| status | RATES_FAILED |
| status | REFERRED |
| status | SUBMIT_FAILED |
| status | SUBMITTED |
| offerType | FIRM |
| offerType | GET_RATES |
| offerType | PREQUALIFIED |
Offer
{
"responseId": "string",
"applicationLender": "string",
"creditOfferType": "FIRM",
"fiId": 0,
"isPrequalified": true,
"denialReason": "NO_LENDER_IN_GEO",
"approvedAmount": "string",
"maxApprovedAmount": "string",
"estimatedMonthlyPayment": "string",
"term": 0,
"rate": "string",
"applicationOfferDate": "2019-08-24",
"applicationOfferExpirationDate": "2019-08-24"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| responseId | string | false | none |
| applicationLender | string | false | none |
| creditOfferType | string | false | none |
| fiId | integer(int32) | false | none |
| isPrequalified | boolean | false | none |
| denialReason | string | false | none |
| approvedAmount | string | false | none |
| maxApprovedAmount | string | false | none |
| estimatedMonthlyPayment | string | false | none |
| term | integer(int32) | false | none |
| rate | string | false | none |
| applicationOfferDate | string(date) | false | none |
| applicationOfferExpirationDate | string(date) | false | none |
Enumerated Values
| Property | Value |
|---|---|
| creditOfferType | FIRM |
| creditOfferType | GET_RATES |
| creditOfferType | PREQUALIFIED |
| denialReason | NO_LENDER_IN_GEO |
| denialReason | CREDIT_SCORE_TOO_LOW |
ApplicationExternalIdBody
{
"applicationExternalId": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| applicationExternalId | string | true | none |
FindApplicationByIdResponse
{
"applicationExternalId": "string",
"consumerExternalId": "string",
"loanId": "string",
"loanNumber": "string",
"status": "APPROVED",
"applicationSource": "string",
"fiId": 0,
"applicationLender": "string",
"loanPurposeType": "AUTO_REFINANCE",
"amount": "string",
"term": "string",
"loanType": "PERSONAL",
"storeNumber": 0,
"storeName": "string",
"employeeName": "string",
"orderNumber": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "2019-08-24",
"ssnLastFour": "string",
"email": "string",
"phone": "string",
"resType": "BUYING_OR_OWN_WITH_MORTGAGE",
"address": "string",
"apt": "string",
"city": "string",
"state": "string",
"zip": "string",
"county": "string",
"addrY": 0,
"addrM": 0,
"housePmt": "string",
"employer": "string",
"empType": "FULL_TIME",
"empTitle": "string",
"empPhone": "string",
"empExt": "string",
"empY": 0,
"empM": 0,
"empAddress": "string",
"empCity": "string",
"empState": "string",
"empZip": "string",
"grossMthInc": "string",
"otherMthInc": "string",
"otherIncType": "NONE",
"prevEmployer": "string",
"prevEmpType": "FULL_TIME",
"prevEmpTitle": "string",
"prevEmpPhone": "string",
"prevEmpExt": "string",
"prevEmpY": 0,
"prevEmpM": 0,
"make": "string",
"model": "string",
"year": "string",
"bodyStyle": "string",
"mileage": 0,
"vin": "string",
"options": "string",
"curPmt": "string",
"curLien": "string",
"prevAddress": "string",
"prevApt": "string",
"prevCity": "string",
"prevState": "string",
"prevZip": "string",
"prevCounty": "string",
"prevAddrY": 0,
"prevAddrM": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| applicationExternalId | string | false | none |
| consumerExternalId | string | false | none |
| loanId | string | false | none |
| loanNumber | string | false | none |
| status | string | false | none |
| applicationSource | string | false | none |
| fiId | integer(int32) | false | none |
| applicationLender | string | false | none |
| loanPurposeType | string | false | none |
| amount | string | false | none |
| term | string | false | none |
| loanType | string | false | none |
| storeNumber | integer(int32) | false | none |
| storeName | string | false | none |
| employeeName | string | false | none |
| orderNumber | string | false | none |
| firstName | string | false | none |
| middleName | string | false | none |
| lastName | string | false | none |
| dob | string(date) | false | none |
| ssnLastFour | string | false | none |
| string | false | none | |
| phone | string | false | none |
| resType | string | false | none |
| address | string | false | none |
| apt | string | false | none |
| city | string | false | none |
| state | string | false | none |
| zip | string | false | none |
| county | string | false | none |
| addrY | integer(int32) | false | none |
| addrM | integer(int32) | false | none |
| housePmt | string | false | none |
| employer | string | false | none |
| empType | string | false | none |
| empTitle | string | false | none |
| empPhone | string | false | none |
| empExt | string | false | none |
| empY | integer(int32) | false | none |
| empM | integer(int32) | false | none |
| empAddress | string | false | none |
| empCity | string | false | none |
| empState | string | false | none |
| empZip | string | false | none |
| grossMthInc | string | false | none |
| otherMthInc | string | false | none |
| otherIncType | string | false | none |
| prevEmployer | string | false | none |
| prevEmpType | string | false | none |
| prevEmpTitle | string | false | none |
| prevEmpPhone | string | false | none |
| prevEmpExt | string | false | none |
| prevEmpY | integer(int32) | false | none |
| prevEmpM | integer(int32) | false | none |
| make | string | false | none |
| model | string | false | none |
| year | string | false | none |
| bodyStyle | string | false | none |
| mileage | integer(int32) | false | none |
| vin | string | false | none |
| options | string | false | none |
| curPmt | string | false | none |
| curLien | string | false | none |
| prevAddress | string | false | none |
| prevApt | string | false | none |
| prevCity | string | false | none |
| prevState | string | false | none |
| prevZip | string | false | none |
| prevCounty | string | false | none |
| prevAddrY | integer(int32) | false | none |
| prevAddrM | integer(int32) | false | none |
Enumerated Values
| Property | Value |
|---|---|
| status | APPROVED |
| status | DECLINED |
| status | IDV_FAILED |
| status | IDV_REJECTED |
| status | IDV_SUCCESS |
| status | NEW |
| status | NOT_QUALIFIED |
| status | PREQUALIFIED |
| status | RATES_FAILED |
| status | REFERRED |
| status | SUBMIT_FAILED |
| status | SUBMITTED |
| loanPurposeType | AUTO_REFINANCE |
| loanPurposeType | DEBT_CONSOLIDATION |
| loanPurposeType | DEFERRED_PAYMENT_REDUCED_INTEREST_LOAN_SIX_MONTH |
| loanPurposeType | DEFERRED_PAYMENT_REDUCED_INTEREST_LOAN_TWELVE_MONTH |
| loanPurposeType | HOME_IMPROVEMENT |
| loanPurposeType | NEW_AUTO |
| loanPurposeType | PERSONAL_EXPENSE |
| loanPurposeType | REDUCED_INTEREST_LOAN_299 |
| loanPurposeType | REDUCED_INTEREST_LOAN_399 |
| loanPurposeType | REDUCED_INTEREST_LOAN_499 |
| loanPurposeType | REDUCED_INTEREST_LOAN_599 |
| loanPurposeType | REDUCED_INTEREST_LOAN_699 |
| loanPurposeType | USED_AUTO |
| loanPurposeType | ZERO_INTEREST_EQUAL_PAYMENT_LOAN |
| loanType | PERSONAL |
| loanType | VEHICLE |
| resType | BUYING_OR_OWN_WITH_MORTGAGE |
| resType | OWN_FREE_AND_CLEAR |
| resType | RENT |
| resType | LIVE_WITH_PARENTS |
| resType | GOVERNMENT_QUARTERS |
| resType | OTHER |
| empType | FULL_TIME |
| empType | PART_TIME |
| empType | SELF_EMPLOYED |
| empType | STUDENT |
| empType | HOMEMAKER |
| empType | UNEMPLOYED |
| empType | MILITARY |
| empType | RETIRED |
| otherIncType | NONE |
| otherIncType | SECONDARY_JOB |
| otherIncType | BONUS_OR_COMMISSION |
| otherIncType | CHILD_SUPPORT |
| otherIncType | DISABILITY |
| otherIncType | INVESTMENTS |
| otherIncType | PENSION_OR_ANNUITY |
| otherIncType | RENTAL_PROPERTY |
| otherIncType | RETIREMENT |
| otherIncType | ROYALTIES |
| otherIncType | SOCIAL_SECURITY |
| otherIncType | TRUST_FUND |
| prevEmpType | FULL_TIME |
| prevEmpType | PART_TIME |
| prevEmpType | SELF_EMPLOYED |
| prevEmpType | STUDENT |
| prevEmpType | HOMEMAKER |
| prevEmpType | UNEMPLOYED |
| prevEmpType | MILITARY |
| prevEmpType | RETIRED |
CreateApplicationResponse
{
"applicationExternalId": "string",
"consumerExternalId": "string",
"status": "APPROVED"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| applicationExternalId | string | false | none |
| consumerExternalId | string | false | none |
| status | string | false | none |
Enumerated Values
| Property | Value |
|---|---|
| status | APPROVED |
| status | DECLINED |
| status | IDV_FAILED |
| status | IDV_REJECTED |
| status | IDV_SUCCESS |
| status | NEW |
| status | NOT_QUALIFIED |
| status | PREQUALIFIED |
| status | RATES_FAILED |
| status | REFERRED |
| status | SUBMIT_FAILED |
| status | SUBMITTED |
SubmitChannelPartnerApplicationResponse
{
"applicationExternalId": "string",
"consumerExternalId": "string",
"status": "APPROVED"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| applicationExternalId | string | false | none |
| consumerExternalId | string | false | none |
| status | string | false | none |
Enumerated Values
| Property | Value |
|---|---|
| status | APPROVED |
| status | DECLINED |
| status | IDV_FAILED |
| status | IDV_REJECTED |
| status | IDV_SUCCESS |
| status | NEW |
| status | NOT_QUALIFIED |
| status | PREQUALIFIED |
| status | RATES_FAILED |
| status | REFERRED |
| status | SUBMIT_FAILED |
| status | SUBMITTED |
SubmitChannelPartnerApplicationRequest
{
"applicationExternalId": "string",
"term": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| applicationExternalId | string | true | none |
| term | integer(int32) | true | none |
OneStepSubmitChannelPartnerApplicationRequest
{
"loanType": "string",
"loanPurposeType": "string",
"amount": "string",
"fiId": 0,
"applicationLender": "string",
"applicationSource": "string",
"term": 0,
"storeNumber": 0,
"storeName": "string",
"employeeName": "string",
"orderNumber": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "2019-08-24",
"ssn": "string",
"creditScore": "string",
"email": "string",
"phone": "string",
"resType": "string",
"address": "string",
"apt": "string",
"city": "string",
"state": "string",
"zip": "string",
"county": "string",
"addrY": 0,
"addrM": 0,
"housePmt": "string",
"employer": "string",
"empType": "string",
"empTitle": "string",
"empPhone": "string",
"empExt": "string",
"empY": 0,
"empM": 0,
"grossMthInc": "string",
"otherMthInc": "string",
"otherIncType": "string",
"prevEmployer": "string",
"prevEmpType": "string",
"prevEmpTitle": "string",
"prevEmpPhone": "string",
"prevEmpExt": "string",
"prevEmpY": 0,
"prevEmpM": 0,
"prevAddress": "string",
"prevApt": "string",
"prevCity": "string",
"prevState": "string",
"prevZip": "string",
"prevCounty": "string",
"prevAddrY": 0,
"prevAddrM": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| loanType | string | true | none |
| loanPurposeType | string | true | none |
| amount | string | true | none |
| fiId | integer(int32) | true | none |
| applicationLender | string | true | none |
| applicationSource | string | true | none |
| term | integer(int32) | true | none |
| storeNumber | integer(int32) | false | none |
| storeName | string | false | none |
| employeeName | string | false | none |
| orderNumber | string | false | none |
| firstName | string | true | none |
| middleName | string | false | none |
| lastName | string | true | none |
| dob | string(date) | true | none |
| ssn | string | true | none |
| creditScore | string | false | none |
| string | true | none | |
| phone | string | true | none |
| resType | string | true | none |
| address | string | true | none |
| apt | string | false | none |
| city | string | true | none |
| state | string | true | none |
| zip | string | true | none |
| county | string | true | none |
| addrY | integer(int32) | true | none |
| addrM | integer(int32) | true | none |
| housePmt | string | true | none |
| employer | string | true | none |
| empType | string | true | none |
| empTitle | string | true | none |
| empPhone | string | true | none |
| empExt | string | false | none |
| empY | integer(int32) | true | none |
| empM | integer(int32) | true | none |
| grossMthInc | string | true | none |
| otherMthInc | string | false | none |
| otherIncType | string | false | none |
| prevEmployer | string | false | none |
| prevEmpType | string | false | none |
| prevEmpTitle | string | false | none |
| prevEmpPhone | string | false | none |
| prevEmpExt | string | false | none |
| prevEmpY | integer(int32) | false | none |
| prevEmpM | integer(int32) | false | none |
| prevAddress | string | false | none |
| prevApt | string | false | none |
| prevCity | string | false | none |
| prevState | string | false | none |
| prevZip | string | false | none |
| prevCounty | string | false | none |
| prevAddrY | integer(int32) | false | none |
| prevAddrM | integer(int32) | false | none |
CreateChannelPartnerApplicationRequest
{
"loanType": "string",
"loanPurposeType": "string",
"amount": "string",
"applicationSource": "string",
"storeNumber": 0,
"storeName": "string",
"employeeName": "string",
"orderNumber": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "2019-08-24",
"ssn": "string",
"creditScore": "string",
"email": "string",
"phone": "string",
"resType": "string",
"address": "string",
"apt": "string",
"city": "string",
"state": "string",
"zip": "string",
"county": "string",
"addrY": 0,
"addrM": 0,
"housePmt": "string",
"employer": "string",
"empType": "string",
"empTitle": "string",
"empPhone": "string",
"empExt": "string",
"empY": 0,
"empM": 0,
"grossMthInc": "string",
"otherMthInc": "string",
"otherIncType": "string",
"prevEmployer": "string",
"prevEmpType": "string",
"prevEmpTitle": "string",
"prevEmpPhone": "string",
"prevEmpExt": "string",
"prevEmpY": 0,
"prevEmpM": 0,
"prevAddress": "string",
"prevApt": "string",
"prevCity": "string",
"prevState": "string",
"prevZip": "string",
"prevCounty": "string",
"prevAddrY": 0,
"prevAddrM": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| loanType | string | true | none |
| loanPurposeType | string | true | none |
| amount | string | true | none |
| applicationSource | string | true | none |
| storeNumber | integer(int32) | false | none |
| storeName | string | false | none |
| employeeName | string | false | none |
| orderNumber | string | false | none |
| firstName | string | true | none |
| middleName | string | false | none |
| lastName | string | true | none |
| dob | string(date) | true | none |
| ssn | string | true | none |
| creditScore | string | false | none |
| string | true | none | |
| phone | string | true | none |
| resType | string | true | none |
| address | string | true | none |
| apt | string | false | none |
| city | string | true | none |
| state | string | true | none |
| zip | string | true | none |
| county | string | true | none |
| addrY | integer(int32) | true | none |
| addrM | integer(int32) | true | none |
| housePmt | string | true | none |
| employer | string | true | none |
| empType | string | true | none |
| empTitle | string | true | none |
| empPhone | string | true | none |
| empExt | string | false | none |
| empY | integer(int32) | true | none |
| empM | integer(int32) | true | none |
| grossMthInc | string | true | none |
| otherMthInc | string | false | none |
| otherIncType | string | false | none |
| prevEmployer | string | false | none |
| prevEmpType | string | false | none |
| prevEmpTitle | string | false | none |
| prevEmpPhone | string | false | none |
| prevEmpExt | string | false | none |
| prevEmpY | integer(int32) | false | none |
| prevEmpM | integer(int32) | false | none |
| prevAddress | string | false | none |
| prevApt | string | false | none |
| prevCity | string | false | none |
| prevState | string | false | none |
| prevZip | string | false | none |
| prevCounty | string | false | none |
| prevAddrY | integer(int32) | false | none |
| prevAddrM | integer(int32) | false | none |
ApplicationSummary
{
"applicationExternalId": "string",
"loanId": "string",
"loanNumber": "string",
"firstName": "string",
"lastName": "string",
"ssnLastFour": "string",
"initialStatus": "APPROVED",
"currentStatus": "string",
"submissionDate": "2019-08-24",
"employeeName": "string",
"storeNumber": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| applicationExternalId | string | false | none |
| loanId | string | false | none |
| loanNumber | string | false | none |
| firstName | string | false | none |
| lastName | string | false | none |
| ssnLastFour | string | false | none |
| initialStatus | string | false | none |
| currentStatus | string | false | none |
| submissionDate | string(date) | false | none |
| employeeName | string | false | none |
| storeNumber | integer(int32) | false | none |
Enumerated Values
| Property | Value |
|---|---|
| initialStatus | APPROVED |
| initialStatus | DECLINED |
| initialStatus | IDV_FAILED |
| initialStatus | IDV_REJECTED |
| initialStatus | IDV_SUCCESS |
| initialStatus | NEW |
| initialStatus | NOT_QUALIFIED |
| initialStatus | PREQUALIFIED |
| initialStatus | RATES_FAILED |
| initialStatus | REFERRED |
| initialStatus | SUBMIT_FAILED |
| initialStatus | SUBMITTED |
SearchApplicationsRequest
{
"applicationSource": "string",
"storeNumber": 0,
"initialApplicationStatus": "string",
"currentApplicationStatus": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| applicationSource | string | true | none |
| storeNumber | integer(int32) | false | none |
| initialApplicationStatus | string | false | none |
| currentApplicationStatus | string | false | none |
Address
{
"streetAddress1": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"county": "string",
"residenceType": "BUYING_OR_OWN_WITH_MORTGAGE",
"monthlyPayment": "string",
"addressYears": 0,
"addressMonths": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| streetAddress1 | string | false | none |
| streetAddress2 | string | false | none |
| city | string | false | none |
| state | string | false | none |
| zipCode | string | false | none |
| county | string | false | none |
| residenceType | string | false | none |
| monthlyPayment | string | false | none |
| addressYears | integer(int32) | false | none |
| addressMonths | integer(int32) | false | none |
Enumerated Values
| Property | Value |
|---|---|
| residenceType | BUYING_OR_OWN_WITH_MORTGAGE |
| residenceType | OWN_FREE_AND_CLEAR |
| residenceType | RENT |
| residenceType | LIVE_WITH_PARENTS |
| residenceType | GOVERNMENT_QUARTERS |
| residenceType | OTHER |
Application
{
"externalId": "string",
"loanType": "PERSONAL",
"loanPurposeType": "AUTO_REFINANCE",
"applicationSource": "string",
"applicationSourceId": "string",
"creditScore": "string",
"status": "APPROVED",
"loanApplicationStatus": "string",
"loanApplicationVendorId": "string",
"loanApplicationSubmissionDate": "2019-08-24",
"loanApplicationExpirationDate": "2019-08-24",
"loanVendorId": "string",
"amountRequested": "string",
"termRequested": 0,
"vehicleLoanDetails": {
"vehicleYear": "string",
"vehicleMake": "string",
"vehicleModel": "string",
"vehicleTrim": "string",
"currentLender": "string",
"currentMonthlyPayment": "string",
"mileage": 0
},
"offers": [
{
"responseId": "string",
"applicationLender": "string",
"creditOfferType": "FIRM",
"fiId": 0,
"isPrequalified": true,
"denialReason": "NO_LENDER_IN_GEO",
"approvedAmount": "string",
"maxApprovedAmount": "string",
"estimatedMonthlyPayment": "string",
"term": 0,
"rate": "string",
"applicationOfferDate": "2019-08-24",
"applicationOfferExpirationDate": "2019-08-24"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| externalId | string | false | none |
| loanType | string | false | none |
| loanPurposeType | string | false | none |
| applicationSource | string | false | none |
| applicationSourceId | string | false | none |
| creditScore | string | false | none |
| status | string | false | none |
| loanApplicationStatus | string | false | none |
| loanApplicationVendorId | string | false | none |
| loanApplicationSubmissionDate | string(date) | false | none |
| loanApplicationExpirationDate | string(date) | false | none |
| loanVendorId | string | false | none |
| amountRequested | string | false | none |
| termRequested | integer(int32) | false | none |
| vehicleLoanDetails | VehicleLoanDetails | false | none |
| offers | [Offer] | false | none |
Enumerated Values
| Property | Value |
|---|---|
| loanType | PERSONAL |
| loanType | VEHICLE |
| loanPurposeType | AUTO_REFINANCE |
| loanPurposeType | DEBT_CONSOLIDATION |
| loanPurposeType | DEFERRED_PAYMENT_REDUCED_INTEREST_LOAN_SIX_MONTH |
| loanPurposeType | DEFERRED_PAYMENT_REDUCED_INTEREST_LOAN_TWELVE_MONTH |
| loanPurposeType | HOME_IMPROVEMENT |
| loanPurposeType | NEW_AUTO |
| loanPurposeType | PERSONAL_EXPENSE |
| loanPurposeType | REDUCED_INTEREST_LOAN_299 |
| loanPurposeType | REDUCED_INTEREST_LOAN_399 |
| loanPurposeType | REDUCED_INTEREST_LOAN_499 |
| loanPurposeType | REDUCED_INTEREST_LOAN_599 |
| loanPurposeType | REDUCED_INTEREST_LOAN_699 |
| loanPurposeType | USED_AUTO |
| loanPurposeType | ZERO_INTEREST_EQUAL_PAYMENT_LOAN |
| status | APPROVED |
| status | DECLINED |
| status | IDV_FAILED |
| status | IDV_REJECTED |
| status | IDV_SUCCESS |
| status | NEW |
| status | NOT_QUALIFIED |
| status | PREQUALIFIED |
| status | RATES_FAILED |
| status | REFERRED |
| status | SUBMIT_FAILED |
| status | SUBMITTED |
Employment
{
"employmentType": "FULL_TIME",
"employer": "string",
"employerPhone": "string",
"jobTitle": "string",
"yearsEmployed": 0,
"monthsEmployed": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| employmentType | string | false | none |
| employer | string | false | none |
| employerPhone | string | false | none |
| jobTitle | string | false | none |
| yearsEmployed | integer(int32) | false | none |
| monthsEmployed | integer(int32) | false | none |
Enumerated Values
| Property | Value |
|---|---|
| employmentType | FULL_TIME |
| employmentType | PART_TIME |
| employmentType | SELF_EMPLOYED |
| employmentType | STUDENT |
| employmentType | HOMEMAKER |
| employmentType | UNEMPLOYED |
| employmentType | MILITARY |
| employmentType | RETIRED |
GetConsumerDataResponse
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"phoneNumber": "string",
"emailAddress": "string",
"ssnLastFour": "string",
"birthYear": "string",
"grossMonthlyIncome": "string",
"otherMonthlyIncome": "string",
"otherIncomeType": "NONE",
"currentEmployment": {
"employmentType": "FULL_TIME",
"employer": "string",
"employerPhone": "string",
"jobTitle": "string",
"yearsEmployed": 0,
"monthsEmployed": 0
},
"previousEmployment": {
"employmentType": "FULL_TIME",
"employer": "string",
"employerPhone": "string",
"jobTitle": "string",
"yearsEmployed": 0,
"monthsEmployed": 0
},
"currentAddress": {
"streetAddress1": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"county": "string",
"residenceType": "BUYING_OR_OWN_WITH_MORTGAGE",
"monthlyPayment": "string",
"addressYears": 0,
"addressMonths": 0
},
"previousAddress": {
"streetAddress1": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"county": "string",
"residenceType": "BUYING_OR_OWN_WITH_MORTGAGE",
"monthlyPayment": "string",
"addressYears": 0,
"addressMonths": 0
},
"applications": [
{
"externalId": "string",
"loanType": "PERSONAL",
"loanPurposeType": "AUTO_REFINANCE",
"applicationSource": "string",
"applicationSourceId": "string",
"creditScore": "string",
"status": "APPROVED",
"loanApplicationStatus": "string",
"loanApplicationVendorId": "string",
"loanApplicationSubmissionDate": "2019-08-24",
"loanApplicationExpirationDate": "2019-08-24",
"loanVendorId": "string",
"amountRequested": "string",
"termRequested": 0,
"vehicleLoanDetails": {
"vehicleYear": "string",
"vehicleMake": "string",
"vehicleModel": "string",
"vehicleTrim": "string",
"currentLender": "string",
"currentMonthlyPayment": "string",
"mileage": 0
},
"offers": [
{
"responseId": "string",
"applicationLender": "string",
"creditOfferType": "FIRM",
"fiId": 0,
"isPrequalified": true,
"denialReason": "NO_LENDER_IN_GEO",
"approvedAmount": "string",
"maxApprovedAmount": "string",
"estimatedMonthlyPayment": "string",
"term": 0,
"rate": "string",
"applicationOfferDate": "2019-08-24",
"applicationOfferExpirationDate": "2019-08-24"
}
]
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| firstName | string | false | none |
| middleName | string | false | none |
| lastName | string | false | none |
| phoneNumber | string | false | none |
| emailAddress | string | false | none |
| ssnLastFour | string | false | none |
| birthYear | string | false | none |
| grossMonthlyIncome | string | false | none |
| otherMonthlyIncome | string | false | none |
| otherIncomeType | string | false | none |
| currentEmployment | Employment | false | none |
| previousEmployment | Employment | false | none |
| currentAddress | Address | false | none |
| previousAddress | Address | false | none |
| applications | [Application] | false | none |
Enumerated Values
| Property | Value |
|---|---|
| otherIncomeType | NONE |
| otherIncomeType | SECONDARY_JOB |
| otherIncomeType | BONUS_OR_COMMISSION |
| otherIncomeType | CHILD_SUPPORT |
| otherIncomeType | DISABILITY |
| otherIncomeType | INVESTMENTS |
| otherIncomeType | PENSION_OR_ANNUITY |
| otherIncomeType | RENTAL_PROPERTY |
| otherIncomeType | RETIREMENT |
| otherIncomeType | ROYALTIES |
| otherIncomeType | SOCIAL_SECURITY |
| otherIncomeType | TRUST_FUND |
VehicleLoanDetails
{
"vehicleYear": "string",
"vehicleMake": "string",
"vehicleModel": "string",
"vehicleTrim": "string",
"currentLender": "string",
"currentMonthlyPayment": "string",
"mileage": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| vehicleYear | string | false | none |
| vehicleMake | string | false | none |
| vehicleModel | string | false | none |
| vehicleTrim | string | false | none |
| currentLender | string | false | none |
| currentMonthlyPayment | string | false | none |
| mileage | integer(int32) | false | none |
ConsumerExternalIdBody
{
"consumerExternalId": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| consumerExternalId | string | true | none |