Loan Application
Submit an Application
Users have the ability to submit an application data API. Creating an application will initiate the approval process. If the process is successful the application will be converted into a loan. To create a new loan application in the system, a user can initiate a POST request directed to the following endpoint:
https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application
This request requires additional data to be included in the body and the header of the request.
Body Parameter Data Element Details:
| Name | Type | Description |
|---|---|---|
| platformReferenceNumber | string | null | Reference number provided by the API caller. This value must be unique within the Program that the application is submitted under. Must be 36 characters long or less. |
| applicationDate | date-time | Date of the loan application. This can be different from the date that the loan application was submitted if the submission was not made at the time of the application |
| requestedLoanAmount | double | The amount of money that was requested |
| approvedLoanAmount | double | The amount of money that was approved |
| apr | double | The APR in a decimal format. An 18.5% APR should be submitted as 18.5 |
| noteRate | double | The rate that exists on the note. An 18.5% rate should be submitted as 18.5 |
| collateralCategory | string | null | A description of the category that any collateral belongs to |
| loanPurpose | string | null | A description of the purpose of the loan |
| defaultProbability | double | The probability, as determined by the API caller, that the loan will default. This is a percentage and 18.5% should be submitted as 18.5 |
| customRiskScore | string | null | A risk score that the API caller has established for the application/borrower(s). This is a text field and can be in any form the API caller desires |
| customGrade | string | null | A grade that the API caller has assigned to this loan application. This is a text field and can be in any form the API caller desires |
| isMlaLoan | boolean | Is the loan application governed by the Military Lending Act (MLA) (true; false) |
| ofacChecked | boolean | Have the borrowers and cosigners been OFAC checked by the API caller (true; false) |
| promotionDetails | object | Details about the promotion associated with a loan application. The object includes the following data: |
| > promotionMonths | int32 | The number of months that any promotion assigned to the application is valid for |
| > promotionExpiryDate | date-time | Date that any promotion assigned to the application will expire on |
| > promotionTypeDescription | string | null | Description of any promotion that has been assigned to the application |
| PropertyDetails | object | Details about the property associated with the loan application. This is required if the program assigned to the loan application is for Home Improvement Loans. The object includes the following data: |
| > streetAddress | string | null | Street Address of the property associated with the application. Must be 255 characters long or less |
| > city | string | null | City of the property associated with the application. Must be 255 characters long or less |
| > state | string | null | State of the property associated with the application. Must be 2 characters long |
| > zipCode | string | null | Zip Code of the property associated with the application |
| > cltv | double | null | Combined loan-to-value (CLTV) ratio for the property |
| originationDetails | object | Details about the origination associated with the loan application. The object includes the following data: |
| > originationMontlyPayment | double | Monthly payment for the application. Must be greater than 0 |
| > originationLoanTerm | int32 | Loan term for the application. Must be greater than 0 |
| > originationMaturityDate | date-time | Maturity date for the application. This value must be in the future when compared to the date the api is being called on |
| > originationFeePercentage | double | Fee percentage for the application |
| > originationFeeAmount | double | Fee amount for the application. This amount is subtracted from the ApprovedLoanAmount to determine the maximum amount of funds that can be disbursed on an application |
| borrowers | array of objects | null | List of all borrowers. The objects(s) includes the following data: |
| > ssn | string | null | Borrower's SSN. This must be between 9 and 11 characters in length and in a valid SSN format |
| > fullName | string | null | Full name of the borrower. Must be 255 characters long or less |
| > dateOfBirth | date-time | Borrower's date of birth. All borrowers must be between 18 and 120 years old on the loan application date |
| > annualIncome | double | This is a required field Annual income of the borrower. |
| > employerName | string | null | Borrower's employer name |
| > emailAddress | string | null | Borrower's email address |
| > schoolName | string | null | Name of the post secondary school the borrower attended |
| > schoolOpeCode | string | null | The Office of Post Secondary Education (OPE) code for the post secondary school the borrower attended |
| > schoolGraduationYear | int32 | null | Year that the borrower graduated from their post secondary school |
| > degreeType | string | null | Type of degree the borrower received when graduating from post secondary school |
| > areaOfStudy | string | null | Area of study for the degree the borrower received |
| > deceased | boolean | Indicates that the borrower is deceased (true; false) |
| > housingStatus | string | Options are: Own Rent |
| > streetAddress | string | null | Street portion of the borrower's primary residence address. Must be 255 characters long or less |
| > city | string | null | City portion of the borrower's primary residence address. Must be 255 characters long or less |
| > state | string | null | State portion of the borrower's primary residence address. Must be 2 characters long |
| > zipCode | string | null | Zip Code portion of the borrower's primary residence address |
| > homePhoneNumber | string | null | Borrower's home phone number |
| > workPhoneNumber | string | null | Borrower's work phone number |
| > cellPhoneNumber | string | null | Borrower's cell phone number |
| > ficoScore | int32 | This is a required fieldBorrower's FICO score. Must be between 0 and 1000 |
| > debtToIncomeRation | double | This is a required fieldBorrower's Debt to Income ratio. Must be between 0.00 and 100.00 |
| cosigners | array of objects | null | List of all cosigners. The objects(s) includes the following data: |
| > ssn | string | null | Cosigner's SSN. This must be between 9 and 11 characters in length and in a valid SSN format |
| > fullName | string | null | Full name of the cosigner. Must be 255 characters long or less |
| > dateOfBirth | date-time | Cosigner's date of birth. All cosigners must be between 18 and 120 years old on the loan application date |
| > annualIncome | double | This is a required fieldAnnual income of the cosigner. |
| > employerName | string | null | Cosigner's employer name |
| > emailAddress | string | null | Cosigner's email address |
| > schoolName | string | null | Name of the post secondary school the cosigner attended |
| > schoolOpeCode | string | null | The Office of Post Secondary Education (OPE) code for the post secondary school the cosigner attended |
| > schoolGraduationYear | int32 | null | Year that the cosigner graduated from their post secondary school |
| > degreeType | string | null | Type of degree the cosigner received when graduating from post secondary school |
| > areaOfStudy | string | null | Area of study for the degree the cosigner received |
| > deceased | boolean | Indicates that the cosigner is deceased (true; false) |
| > housingStatus | string | Options are: Own Rent |
| > streetAddress | string | null | Street portion of the cosigner's primary residence address. Must be 255 characters long or less |
| > city | string | null | City portion of the cosigner's primary residence address. Must be 255 characters long or less |
| > state | string | null | State portion of the cosigner's primary residence address. Must be 2 characters long |
| > zipCode | string | null | Zip Code portion of the cosigner's primary residence address |
| > homePhoneNumber | string | null | Cosigner's home phone number |
| > workPhoneNumber | string | null | Cosigner's work phone number |
| > cellPhoneNumber | string | null | Cosigner's cell phone number |
| > ficoScore | int32 | This is a required fieldCosigner's FICO score. Must be between 0 and 1000 |
| > debtToIncomeRatio | double | This is a required field.Cosigner's Debt to Income ratio. Must be between 0.00 and 100.00 |
| programId | string | The id of the program that this application is being submitted under. A list of programs available for the Partner is available by calling the GET /program API |
| loanAccountNumber | string | null | The loan account number assigned to this application by the caller. This value must be unique within the Program that the application is submitted under. Must be 20 characters long or less |
| fundImmediatelyOnApproval | boolean | Indicates that this application should be immediately funded using the ImmediateFundingInstructions when it is approved and converted from an application to a loan. (true; false) |
| immediateFundingInstructions | array of objects | null | List of funding instructions to be executed if the application is approved and the FundImmediatelyOnApproval flag is set to true. The object includes the following data: |
| > amountToFund | double | This is a required fieldAmount of money to disburse against the loan. Must be greater than 0 |
| > routingNumber | string | null | This is a required fieldRouting number of the account the funds are disbursing to. Must be between 1 and 10 characters long |
| > accountNumber | string | null | This is a required fieldAccount number that the funds are disbursing to. Must be 255 characters long or less |
| > accountName | string | null | This is a required fieldThe name on the account that the funds are disbursing to. Must be 255 characters long or less |
| > accountType | string | Options are: Checking Savings |
| > platformReferencenumber | string | null | This is a required fieldReference number provided by the API caller. Must be 255 characters long or less |
Headers Details
| Name | Type | Description |
|---|---|---|
| x-idempotency-key | string | This is a required field Format - uuid. Unique request identifier for idempotency. Example: 684fbf92-57db-47cd-bf6d-3641c2360005 |
Example Request:
curl --request POST \
--url https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application \
--header 'accept: application/json' \
--header 'content-type: application/*+json' \
--header 'x-idempotency-key: B3C52CA2-15E8-4574-B8D1-9AC3AC0D3BCC' \
--data '
{
"propertyDetails": {
"streetAddress": "742 Evergreen Terrace",
"city": "Springfield",
"state": "CT",
"zipCode": "12345",
"cltv": 113.4
},
"originationDetails": {
"originationMonthlyPayment": 123.44,
"originationLoanTerm": 24,
"originationMaturityDate": "2026-02-05 00:00:00",
"originationFeePercentage": 1.33,
"originationFeeAmount": 120
},
"platformReferenceNumber": "fc47b2a2-6884-4d87-911e-b1bf010ea894",
"applicationDate": "2024-02-05 10:00:00",
"requestedLoanAmount": 1200,
"approvedLoanAmount": 1100,
"apr": 14.5,
"noteRate": 14.5,
"collateralCategory": "Vehicle",
"loanPurpose": "House repair",
"defaultProbability": 11.1,
"customRiskScore": "66f",
"customGrade": "8a",
"isMlaLoan": false,
"ofacChecked": true,
"borrowers": [
{
"ssn": "123-123-123",
"fullName": "Home Simpson",
"dateOfBirth": "1960-05-05 00:00:00",
"annualIncome": 87454,
"employerName": "Burns Power",
"emailAddress": "[email protected]",
"schoolName": "Power Trades University",
"schoolOpeCode": "234",
"schoolGraduationYear": 1981,
"degreeType": "BSc",
"areaOfStudy": "Physics",
"deceased": false,
"housingStatus": "Own",
"streetAddress": "742 Evergreen Terrace",
"city": "Springfield",
"state": "CT",
"zipCode": "12345",
"homePhoneNumber": "555-555-5555",
"workPhoneNumber": "555-555-7777",
"cellPhoneNumber": "555-555-4444",
"ficoScore": 800,
"debtToIncomeRatio": 45.55
}
],
"programId": "fc47b2a2-6884-4d87-911e-b1bf010ea894",
"loanAccountNumber": "12358484",
"fundImmediatelyOnApproval": true,
"immediateFundingInstructions": [
{
"amountToFund": 1000,
"routingNumber": "12345",
"accountNumber": "987654321",
"accountName": "Home Simpson",
"platformReferenceNumber": "765432"
}
]
}
'
A successful request will generate a response of 202 - Accepted
Example Response:
{
"id": "3d269e9c-2cc5-404f-85f8-b213012eaaec"
}
Response Data Element Details:
| Name | Type | Description |
|---|---|---|
| id | string | The id assigned to the application |
| immediateFundingInstructions | array of objects | null | List of all the immediate funding instructions that were received as part of this request. This includes the Platform Reference Number that was submitted and the Funding Instruction Id to allow the caller to link any webhooks about the funding instruction to this request. The object includes the following data: |
| > platformReferenceNumber | string | null | The Platform Reference Number that was provided when the funding instruction was submitted |
| > fundingInstructionId | string | The Funding Instruction Id that will be used in webhooks indicating changes in state to the funding instruction |
Error Handling:
Common errors will include:
400 – Bad Request
401 – Unauthorized
403 - Forbidden
422 – Unprocessable Content
500 – Internal Server Error
For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.
View all Applications (with pagination)
A user has the ability to view details for all applications submitted. This endpoint includes pagination which allows a user to request a subset of applications. To view all application details, a user can initiate a GET request directed to the following endpoint:
https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application
This request requires query parameters to be included in the request.
Query Parameter Data Element Details:
| Name | Type | Description |
|---|---|---|
| paginateResults | boolean | indicates whether the request should be paginated |
| page | int32 | indicates the page to return |
| perPage | int32 | indicates how many items are on a page |
| sortOn | string | indicates the attribute by which the data is sorted |
| sortAscending | string | indicates if the data is sorted in ascending or descending order |
Example Request:
curl --request GET \
--url 'https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application?paginateResults=true&page=1&perPage=10' \
--header 'accept: application/json'
A successful request will generate a response of 200 - Ok.
Example Response:
{
"pageSize": 100,
"pageOffset": 0,
"totalPages": 1,
"totalItemCount": 2,
"items": [
{
"id": "a360c386-b4aa-4be4-ac4d-b1bf010e44f7",
"platformReferenceNumber": "ref2024-9876",
"applicationDate": "2024-06-11T00:00:00",
"requestedLoanAmount": 500000.00,
"approvedLoanAmount": 500000.00,
"apr": 12.45000,
"noteRate": 12.55000,
"loanAccountNumber": "HI1234-55",
"collateralCategory": "Vehicle",
"loanPurpose": "Bathroom reno",
"defaultProbability": 1.44000,
"customRiskScore": "3AAA",
"customGrade": "3A",
"mlaLoan": true,
"ofacChecked": true,
"promotionDetails": {
"promotionMonths": 1,
"promotionExpiryDate": "2024-05-30T00:00:00",
"promotionTypeDescription": "No interest for 1 month"
},
"propertyDetails": {
"streetAddress": "1234 Possum Lane",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-9876",
"cltv": 22.33000
},
"programId": "a3cf82e1-14ff-477a-9459-b1bf010a1b8e",
"applicationStatus": "Rejected",
"borrowers": [
{
"id": "d8c6a2b1-4bab-47f2-8abb-b1bf010e4597",
"ssn": "123011234",
"fullName": "Fred Flinstone",
"dateOfBirth": "1955-07-10T00:00:00",
"annualIncome": 25000.00,
"employerName": "Burnside Factory",
"emailAddress": "[email protected]",
"schoolName": "FSU",
"schoolOpeCode": "FSU",
"schoolGraduationYear": 1999,
"degreeType": "BSc",
"areaOfStudy": "Geology",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "1234 Possum Lane",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-6789",
"homePhoneNumber": "888-123-4567",
"workPhoneNumber": "888-987-6543",
"cellPhoneNumber": "888-453-7869",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"cosigners": [
{
"id": "355eb3ff-4a7e-4132-a24f-b1bf010e4598",
"ssn": "777777777",
"fullName": "Barney Rubble",
"dateOfBirth": "1966-10-21T00:00:00",
"annualIncome": 25000.00,
"employerName": "NA",
"emailAddress": "[email protected]",
"schoolName": "NA",
"schoolOpeCode": "NA",
"schoolGraduationYear": 1900,
"degreeType": "NA",
"areaOfStudy": "NA",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "1234 Possum Lane",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-6789",
"homePhoneNumber": "888-123-4567",
"cellPhoneNumber": "888-453-1234",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"rejectionReasons": [
{
"processingDate": "2024-08-01T16:24:02.8",
"ruleName": "Application Approval - Approved Loan Amount",
"errorMessage": "Failed Loan Amount check"
}
],
"originationDetails": {
"originationMonthlyPayment": 100.00,
"originationLoanTerm": 12,
"originationMaturityDate": "2025-05-30T00:00:00",
"originationFeePercentage": 11.23300,
"originationFeeAmount": 200.00
},
"fundImmediatelyOnApproval": true,
"immediateFundingInstructions": [
{
"amountToFund": 5555.55,
"routingNumber": "434898736",
"accountNumber": "234588767",
"accountName": "Bob Loblaw",
"accountType": "Checking",
"receivedDate": "2024-08-01T16:24:01.7850276"
},
{
"amountToFund": 2812.44,
"routingNumber": "435001237",
"accountNumber": "8722838",
"accountName": "Sam Smith",
"accountType": "Checking",
"receivedDate": "2024-08-01T16:24:01.7852321"
},
{
"amountToFund": 1234.55,
"routingNumber": "987612345",
"accountNumber": "9987876",
"accountName": "Bob Johnson",
"accountType": "Savings",
"receivedDate": "2024-08-01T16:24:01.7852304"
}
]
},
{
"id": "a64d4499-c0fd-408f-8db3-b1bf010eee8a",
"platformReferenceNumber": "ref2024-9876",
"applicationDate": "2024-06-11T00:00:00",
"requestedLoanAmount": 24000.00,
"approvedLoanAmount": 24000.00,
"apr": 12.45000,
"noteRate": 12.55000,
"loanAccountNumber": "HI1234-55",
"collateralCategory": "78 Impala",
"loanPurpose": "New toilet",
"defaultProbability": 1.44000,
"customRiskScore": "3AAA",
"customGrade": "3A",
"mlaLoan": true,
"ofacChecked": true,
"promotionDetails": {
"promotionMonths": 1,
"promotionExpiryDate": "2024-05-30T00:00:00",
"promotionTypeDescription": "1 month no interest"
},
"propertyDetails": {
"streetAddress": "7765 Main Street",
"city": "Springfield",
"state": "IL",
"zipCode": "12345-9876",
"cltv": 18.8800
},
"programId": "a3cf82e1-14ff-477a-9459-b1bf010a1b8e",
"applicationStatus": "Approved",
"borrowers": [
{
"id": "0b16b9f5-b5d7-4a39-9656-b1bf010eee96",
"ssn": "123011234",
"fullName": "Jessie MacCailein",
"dateOfBirth": "1958-11-10T00:00:00",
"annualIncome": 25000.00,
"employerName": "Acme Widgets",
"emailAddress": "[email protected]",
"schoolName": "FSU",
"schoolOpeCode": "FSU",
"schoolGraduationYear": 1980,
"degreeType": "BSc",
"areaOfStudy": "Mechanical Engineering",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "7765 Main Street",
"city": "Springfield",
"state": "IL",
"zipCode": "12345-9876",
"homePhoneNumber": "888-123-4567",
"workPhoneNumber": "888-987-6543",
"cellPhoneNumber": "888-453-7869",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"cosigners": [
{
"id": "03fc4e0b-8861-4ee7-87ee-b1bf010eee96",
"ssn": "777777777",
"fullName": "Katrina Gilchrist",
"dateOfBirth": "1961-03-13T00:00:00",
"annualIncome": 25000.00,
"employerName": "NA",
"emailAddress": "[email protected]",
"schoolName": "NA",
"schoolOpeCode": "NA",
"schoolGraduationYear": 1984,
"degreeType": "NA",
"areaOfStudy": "NA",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "7765 Main Street",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-9876",
"homePhoneNumber": "888-123-4567",
"cellPhoneNumber": "888-453-1234",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"rejectionReasons": [],
"originationDetails": {
"originationMonthlyPayment": 100.00,
"originationLoanTerm": 12,
"originationMaturityDate": "2025-05-30T00:00:00",
"originationFeePercentage": 1.6100,
"originationFeeAmount": 200.00
},
"fundImmediatelyOnApproval": false,
"loanId": "c58c02f4-ce15-40ca-a94a-4c5758e00c3c"
}
]
}
Response Data Element Details:
| Name | Type | Description |
|---|---|---|
| pageSize | int32 | Number of items displayed on a page |
| pageOffset | int32 | Offset index indicating starting point for pate items |
| totalPages | int32 | Total number of pages |
| totalItemCount | int32 | Total count of items across all pages |
| items | array of objects | The response object includes the following data: |
| > id | string | The application's Id |
| > platformReferenceNumber | string | null | Platform Reference Number |
| > applicationDate | date-time | Loan Application Date. |
| > requestedLoanAmount | double | The amount of money that was requested |
| > approvedLoanAmount | double | The amount of money that was approved |
| > apr | double | The APR on the application |
| > noteRate | double | The rate on the application |
| > loanAccountNumber | string | null | The loan account number on the application |
| > collateralCategory | string | null | The category that any collateral belongs to |
| > loanPurpose | string | null | A description of the purpose of the loan |
| > defaultProbability | double | The probability of default that was provided on the application |
| > customRiskScore | string | null | The custom risk score provided on the application |
| > customGrade | string | null | The custom grade provided on the application |
| > mlaLoan | boolean | The Military Lending Act (MLA) status provided on the application |
| > ofacChecked | boolean | The OFAC check status provided on the application |
| > promotionDetails | object | Details about the promotion associated with a loan application. The object includes the following data: |
| > > promotionMonths | int32 | The number of months that any promotion assigned to the application is valid for |
| > > promotionExpiryDate | date-time | Date that any promotion assigned to the application will expire on |
| > > promotionTypeDescription | string | null | Description of any promotion that has been assigned to the application |
| > propertyDetails | object | Details about the property associated with the loan application. This is required if the program assigned to the loan application is for Home Improvement Loans. The object includes the following data: |
| > > streetAddress | string | null | Street Address of the property associated with the application. Must be 255 characters long or less |
| > > city | string | null | City of the property associated with the application. Must be 255 characters long or less |
| > > state | string | null | State of the property associated with the application. Must be 2 characters long |
| > > zipCode | string | null | Zip Code of the property associated with the application |
| > > cltv | double | null | Combined loan-to-value (CLTV) ratio for the property |
| > programId | string | The Combined loan-to-value (CLTV) ration provided on the application |
| > applicationStatus | string | null | The current status of the application in the ingestion and approval process |
| > borrowers | array of objects | null | List of all borrowers submitted on the application. The object includes the following data: |
| > > id | string | The id of the borrower that was included on the application. This is unique to this application. If the same borrower is included on many different applications, each of those borrower entries will have a different id value |
| > > ssn | string | null | The SSN of the borrower |
| > > fullName | string | null | The full name of the borrower |
| > > dateOfBirth | date-time | The date of birth of the borrower. |
| > > annualIncome | double | The annual income of the borrower |
| > > employerNmae | string | null | The name of the borrower's employer |
| > > emailAddress | string | null | The email address of the borrower |
| > > schoolName | string | null | The post secondary school the borrower attended |
| > > schoolOpeCode | string | null | The Office of Post Secondary Education (OPE) code for the post secondary school the borrower attended |
| > > schoolGraduationYear | int32 | null | The year that the borrower graduated from their post secondary school |
| > > degreeType | string | null | The type of degree that the borrower received |
| > > areaOfStudy | string | null | The borrower's area of study in post secondary school |
| > > deceased | boolean | Indicates that the borrower is deceased |
| > > housingStatus | string | Options are: Own Rent |
| > > streetAddress | string | null | The street portion of the borrower's primary residence address |
| > > city | string | null | The city portion of the borrower's primary residence address |
| > > state | string | null | The state portion of the borrower's primary residence address |
| > > zipCode | string | null | The Zip Code portion of the borrower's primary residence address |
| > > homePhoneNumber | string | null | The home phone number of the borrower |
| > > workPhoneNumber | string | null | The work phone number of the borrower |
| > > cellPhoneNumber | string | null | The cell phone number of the borrower |
| > > ficoScore | int32 | The borrower's FICO score |
| > > debtToIncomeRatio | double | The borrower's debt to income ratio |
| > cosigners | array of objects | null | List of all cosigners submitted on the application. The object includes the following data: |
| > > id | string | The id of the cosigner that was included on the application. This is unique to this application. If the same cosigner is included on many different applications, each of those cosigner entries will have a different id value |
| > > ssn | string | null | The SSN of the cosigner |
| > > fullName | string | null | The full name of the cosigner |
| > > dateOfBirth | date-time | The date of birth of the cosigner |
| > > annualIncome | double | The annual income of the cosigner |
| > > employerName | string | null | The name of the cosigner's employer |
| > > emailAddress | string | null | The email of the cosigner |
| > > schoolName | string | null | The post secondary school that the cosigner attended |
| > > schoolOpeCode | string | null | The Office of Post Secondary Education (OPE) code for the post secondary school the cosigner attended |
| > > schoolGraduationYear | int32 | null | The year that the cosigner graduated from their post secondary school |
| > > degreeType | string | null | The type of degree that the cosigner received |
| > > areaOfStudy | string | null | The cosigner's area of study in post secondary school |
| > > deceased | boolean | Indicates if the cosigner id deceased |
| > > housingStatus | string | Options are: Own Rent |
| > > streetAddress | string | null | The street portion of the cosigner's primary residence address |
| > > city | string | null | The city portion of the cosigner's primary residence address |
| > > state | string | null | The state portion of the cosigner's primary residence address |
| > > zipCode | string | null | the Zip Code portion of the cosigner's primary residence address |
| > > homePhoneNumber | string | null | The home phone number of the cosigner |
| > > workPhoneNumber | string | null | The work phone number of the cosigner |
| > > cellPhoneNumber | string | null | The cell phone number of the cosigner |
| > > ficoScore | int32 | The cosigner's FICO score |
| > > debtToIncomeRatio | double | The cosigner's debt to income ratio |
| > rejectionReasons | array of objects | null | List of any rejection reasons if the application was rejected and is in the Rejected Application Status state. The object contains the following data: |
| > > processingDate | date-time | The date that the application processing occurred on. This value will in UTC |
| > > ruleName | string | null | The rule name that caused the failure |
| > > errorMessage | string | null | The error message associated with the failing rule |
| > originationDetails | object | Details about the origination associated with the loan application. The object contains the following data: |
| > > originationMonthlyPayment | double | Monthly payment for the application. Must be greater than 0 |
| > > originationLoanTerm | int32 | Loan term for the application. Must be greater than 0 |
| > > originationMaturityDate | date-time | Maturity date for the application. This value must be in the future when compared to the date the api is being called on |
| > > originationFeePercentage | double | Fee percentage for the application |
| > > originationFeeAmount | double | Fee amount for the application. This amount is subtracted from the ApprovedLoanAmount to determine the maximum amount of funds that can be disbursed on an application |
| > fundImmediatelyOnApproval | boolean | Indicates that this application should be immediately funded using the ImmediateFundingInstructions when it is approved and converted from an application to a loan. (true; false) |
| > immediateFundingInstructions | array of objects | List of funding instructions, that were submitted with the application, indicating what disbursements to perform if the Fund Immediately On Approval flag was set to true. The object contains the following data: |
| > > amountToFund | double | Amount of money to disburse against the loan |
| > > routingNumber | string | null | Routing number of the account the funds are disbursing to |
| > > accountNumber | string | null | Account number that the funds are disbursing to |
| > > accountName | string | null | The name on the account that the funds are disbursing to |
| > > accountType | string | Options are: Checking Savings |
| > > receivedDate | date-time | The name on the account that the funds are disbursing to |
| > > platformReferenceNumber | string | null | The reference number provided by the API caller |
| > loanId | string | null | The loan id that this application is associated with. This value will be null if the application has not been processed or has been rejected |
Error Handling:
Common errors will include:
400 – Bad Request
401 – Unauthorized
403 - Forbidden
422 – Unprocessable Content
500 – Internal Server Error
For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.
View a Specific Application
Similar to the prior request, a user can obtain the same level of information for a specific application if they know the Application Id of the transaction. To get information for a specific application, a user can initiate a GET request directed to the following endpoint:
https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application/{id}
This request requires additional data to be included in the path of the request.
Path Parameter Data Element Details:
| Name | Type | Description |
|---|---|---|
| ID | string | requiredFormat - uuid. The application id to be retrieved |
Example Request:
curl --request GET \
--url https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application/a360c386-b4aa-4be4-ac4d-b1bf010e44f7 \
--header 'accept: application/json'
A successful request will generate a response of 200 - Ok.
Example Response:
{
"id": "a360c386-b4aa-4be4-ac4d-b1bf010e44f7",
"platformReferenceNumber": "ref2024-9876",
"applicationDate": "2024-06-11T00:00:00",
"requestedLoanAmount": 500000.00,
"approvedLoanAmount": 500000.00,
"apr": 12.45000,
"noteRate": 12.55000,
"loanAccountNumber": "HI1234-55",
"collateralCategory": "Vehicle",
"loanPurpose": "Bathroom reno",
"defaultProbability": 1.44000,
"customRiskScore": "3AAA",
"customGrade": "3A",
"mlaLoan": true,
"ofacChecked": true,
"promotionDetails": {
"promotionMonths": 1,
"promotionExpiryDate": "2024-05-30T00:00:00",
"promotionTypeDescription": "No interest for 1 month"
},
"propertyDetails": {
"streetAddress": "1234 Possum Lane",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-9876",
"cltv": 22.33000
},
"programId": "a3cf82e1-14ff-477a-9459-b1bf010a1b8e",
"applicationStatus": "Rejected",
"borrowers": [
{
"id": "d8c6a2b1-4bab-47f2-8abb-b1bf010e4597",
"ssn": "123011234",
"fullName": "Fred Flinstone",
"dateOfBirth": "1955-07-10T00:00:00",
"annualIncome": 25000.00,
"employerName": "Burnside Factory",
"emailAddress": "[email protected]",
"schoolName": "FSU",
"schoolOpeCode": "FSU",
"schoolGraduationYear": 1999,
"degreeType": "BSc",
"areaOfStudy": "Geology",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "1234 Possum Lane",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-6789",
"homePhoneNumber": "888-123-4567",
"workPhoneNumber": "888-987-6543",
"cellPhoneNumber": "888-453-7869",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"cosigners": [
{
"id": "355eb3ff-4a7e-4132-a24f-b1bf010e4598",
"ssn": "777777777",
"fullName": "Barney Rubble",
"dateOfBirth": "1966-10-21T00:00:00",
"annualIncome": 25000.00,
"employerName": "NA",
"emailAddress": "[email protected]",
"schoolName": "NA",
"schoolOpeCode": "NA",
"schoolGraduationYear": 1900,
"degreeType": "NA",
"areaOfStudy": "NA",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "1234 Possum Lane",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-6789",
"homePhoneNumber": "888-123-4567",
"cellPhoneNumber": "888-453-1234",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"rejectionReasons": [
{
"processingDate": "2024-08-01T16:24:02.8",
"ruleName": "Application Approval - Approved Loan Amount",
"errorMessage": "Failed Loan Amount check"
}
],
"originationDetails": {
"originationMonthlyPayment": 100.00,
"originationLoanTerm": 12,
"originationMaturityDate": "2025-05-30T00:00:00",
"originationFeePercentage": 11.23300,
"originationFeeAmount": 200.00
},
"fundImmediatelyOnApproval": true,
"immediateFundingInstructions": [
{
"amountToFund": 5555.55,
"routingNumber": "434898736",
"accountNumber": "234588767",
"accountName": "Bob Loblaw",
"accountType": "Checking",
"receivedDate": "2024-08-01T16:24:01.7850276"
},
{
"amountToFund": 2812.44,
"routingNumber": "435001237",
"accountNumber": "8722838",
"accountName": "Sam Smith",
"accountType": "Checking",
"receivedDate": "2024-08-01T16:24:01.7852321"
},
{
"amountToFund": 1234.55,
"routingNumber": "987612345",
"accountNumber": "9987876",
"accountName": "Bob Johnson",
"accountType": "Savings",
"receivedDate": "2024-08-01T16:24:01.7852304"
}
]
}
Response Data Element Details:
| Name | Type | Description |
|---|---|---|
| id | string | The application's Id |
| platformReferenceNumber | string | null | Platform Reference Number |
| applicationDate | date-time | Loan Application Date. |
| requestedLoanAmount | double | The amount of money that was requested |
| approvedLoanAmount | double | The amount of money that was approved |
| apr | double | The APR on the application |
| noteRate | double | The rate on the application |
| loanAccountNumber | string | null | The loan account number on the application |
| collateralCategory | string | null | The category that any collateral belongs to |
| loanPurpose | string | null | A description of the purpose of the loan |
| defaultProbability | double | The probability of default that was provided on the application |
| customRiskScore | string | null | The custom risk score provided on the application |
| customGrade | string | null | The custom grade provided on the application |
| mlaLoan | boolean | The Military Lending Act (MLA) status provided on the application |
| ofacChecked | boolean | The OFAC check status provided on the application |
| promotionDetails | object | Details about the promotion associated with a loan application. The object includes the following data: |
| > promotionMonths | int32 | The number of months that any promotion assigned to the application is valid for |
| > promotionExpiryDate | date-time | Date that any promotion assigned to the application will expire on |
| > promotionTypeDescription | string | null | Description of any promotion that has been assigned to the application |
| propertyDetails | object | Details about the property associated with the loan application. This is required if the program assigned to the loan application is for Home Improvement Loans. The object includes the following data: |
| > streetAddress | string | null | Street Address of the property associated with the application. Must be 255 characters long or less |
| > city | string | null | City of the property associated with the application. Must be 255 characters long or less |
| > state | string | null | State of the property associated with the application. Must be 2 characters long |
| > zipCode | string | null | Zip Code of the property associated with the application |
| > cltv | double | null | Combined loan-to-value (CLTV) ratio for the property |
| programId | string | The Combined loan-to-value (CLTV) ration provided on the application |
| applicationStatus | string | null | The current status of the application in the ingestion and approval process |
| borrowers | array of objects | null | List of all borrowers submitted on the application. The object includes the following data: |
| > id | string | The id of the borrower that was included on the application. This is unique to this application. If the same borrower is included on many different applications, each of those borrower entries will have a different id value |
| > ssn | string | null | The SSN of the borrower |
| > fullName | string | null | The full name of the borrower |
| > dateOfBirth | date-time | The date of birth of the borrower. |
| > annualIncome | double | The annual income of the borrower |
| > employerNmae | string | null | The name of the borrower's employer |
| > emailAddress | string | null | The email address of the borrower |
| > schoolName | string | null | The post secondary school the borrower attended |
| > schoolOpeCode | string | null | The Office of Post Secondary Education (OPE) code for the post secondary school the borrower attended |
| > schoolGraduationYear | int32 | null | The year that the borrower graduated from their post secondary school |
| > degreeType | string | null | The type of degree that the borrower received |
| > areaOfStudy | string | null | The borrower's area of study in post secondary school |
| > deceased | boolean | Indicates that the borrower is deceased |
| > housingStatus | string | Options are: Own Rent |
| > streetAddress | string | null | The street portion of the borrower's primary residence address |
| > city | string | null | The city portion of the borrower's primary residence address |
| > state | string | null | The state portion of the borrower's primary residence address |
| > zipCode | string | null | The Zip Code portion of the borrower's primary residence address |
| > homePhoneNumber | string | null | The home phone number of the borrower |
| > workPhoneNumber | string | null | The work phone number of the borrower |
| > cellPhoneNumber | string | null | The cell phone number of the borrower |
| > ficoScore | int32 | The borrower's FICO score |
| > debtToIncomeRatio | double | The borrower's debt to income ratio |
| cosigners | array of objects | null | List of all cosigners submitted on the application. The object includes the following data: |
| > id | string | The id of the cosigner that was included on the application. This is unique to this application. If the same cosigner is included on many different applications, each of those cosigner entries will have a different id value |
| > ssn | string | null | The SSN of the cosigner |
| > fullName | string | null | The full name of the cosigner |
| > dateOfBirth | date-time | The date of birth of the cosigner |
| > annualIncome | double | The annual income of the cosigner |
| > employerName | string | null | The name of the cosigner's employer |
| > emailAddress | string | null | The email of the cosigner |
| > schoolName | string | null | The post secondary school that the cosigner attended |
| > schoolOpeCode | string | null | The Office of Post Secondary Education (OPE) code for the post secondary school the cosigner attended |
| > schoolGraduationYear | int32 | null | The year that the cosigner graduated from their post secondary school |
| > degreeType | string | null | The type of degree that the cosigner received |
| > areaOfStudy | string | null | The cosigner's area of study in post secondary school |
| > deceased | boolean | Indicates if the cosigner id deceased |
| > housingStatus | string | Options are: Own Rent |
| > streetAddress | string | null | The street portion of the cosigner's primary residence address |
| > city | string | null | The city portion of the cosigner's primary residence address |
| > state | string | null | The state portion of the cosigner's primary residence address |
| > zipCode | string | null | the Zip Code portion of the cosigner's primary residence address |
| > homePhoneNumber | string | null | The home phone number of the cosigner |
| > workPhoneNumber | string | null | The work phone number of the cosigner |
| > cellPhoneNumber | string | null | The cell phone number of the cosigner |
| > ficoScore | int32 | The cosigner's FICO score |
| > debtToIncomeRatio | double | The cosigner's debt to income ratio |
| rejectionReasons | array of objects | null | List of any rejection reasons if the application was rejected and is in the Rejected Application Status state. The object contains the following data: |
| > processingDate | date-time | The date that the application processing occurred on. This value will in UTC |
| > ruleName | string | null | The rule name that caused the failure |
| > errorMessage | string | null | The error message associated with the failing rule |
| originationDetails | object | Details about the origination associated with the loan application. The object contains the following data: |
| > originationMonthlyPayment | double | Monthly payment for the application. Must be greater than 0 |
| > originationLoanTerm | int32 | Loan term for the application. Must be greater than 0 |
| > originationMaturityDate | date-time | Maturity date for the application. This value must be in the future when compared to the date the api is being called on |
| > originationFeePercentage | double | Fee percentage for the application |
| > originationFeeAmount | double | Fee amount for the application. This amount is subtracted from the ApprovedLoanAmount to determine the maximum amount of funds that can be disbursed on an application |
| fundImmediatelyOnApproval | boolean | Indicates that this application should be immediately funded using the ImmediateFundingInstructions when it is approved and converted from an application to a loan. (true; false) |
| immediateFundingInstructions | array of objects | List of funding instructions, that were submitted with the application, indicating what disbursements to perform if the Fund Immediately On Approval flag was set to true. The object contains the following data: |
| > amountToFund | double | Amount of money to disburse against the loan |
| > routingNumber | string | null | Routing number of the account the funds are disbursing to |
| > accountNumber | string | null | Account number that the funds are disbursing to |
| > accountName | string | null | The name on the account that the funds are disbursing to |
| > accountType | string | Options are: Checking Savings |
| > receivedDate | date-time | The name on the account that the funds are disbursing to |
| > platformReferenceNumber | string | null | The reference number provided by the API caller |
| loanId | string | null | The loan id that this application is associated with. This value will be null if the application has not been processed or has been rejected |
Error Handling:
Common errors will include:
400 – Bad Request
401 – Unauthorized
403 - Forbidden
422 – Unprocessable Content
500 – Internal Server Error
For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.
View All Applications (without pagination)
A user has the ability to view details for all applications submitted. This endpoint does not allow for pagination and provides a complete list of applications for all time. To view all application details, a user can initiate a GET request directed to the following endpoint:
https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application/download
This request requires query parameters to be included in the request.
Query Parameter Data Element Details:
| Name | Type | Description |
|---|---|---|
| paginateResults | boolean | indicates whether the request should be paginated |
| page | int32 | indicates the page to return |
| perPage | int32 | indicates how many items are on a page |
| sortOn | string | indicates the attribute by which the data is sorted |
| sortAscending | string | indicates if the data is sorted in ascending or descending order |
Example Request:
curl --request GET \
--url 'https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application/download?paginateResults=true&page=1&perPage=100' \
--header 'accept: application/json'
A successful request will generate a response of 200 - Ok.
Example Response:
{
"pageSize": 100,
"pageOffset": 0,
"totalPages": 1,
"totalItemCount": 2,
"items": [
{
"id": "a360c386-b4aa-4be4-ac4d-b1bf010e44f7",
"platformReferenceNumber": "ref2024-9876",
"applicationDate": "2024-06-11T00:00:00",
"requestedLoanAmount": 500000.00,
"approvedLoanAmount": 500000.00,
"apr": 12.45000,
"noteRate": 12.55000,
"loanAccountNumber": "HI1234-55",
"collateralCategory": "Vehicle",
"loanPurpose": "Bathroom reno",
"defaultProbability": 1.44000,
"customRiskScore": "3AAA",
"customGrade": "3A",
"mlaLoan": true,
"ofacChecked": true,
"promotionDetails": {
"promotionMonths": 1,
"promotionExpiryDate": "2024-05-30T00:00:00",
"promotionTypeDescription": "No interest for 1 month"
},
"propertyDetails": {
"streetAddress": "1234 Possum Lane",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-9876",
"cltv": 22.33000
},
"programId": "a3cf82e1-14ff-477a-9459-b1bf010a1b8e",
"applicationStatus": "Rejected",
"borrowers": [
{
"id": "d8c6a2b1-4bab-47f2-8abb-b1bf010e4597",
"ssn": "123011234",
"fullName": "Fred Flinstone",
"dateOfBirth": "1955-07-10T00:00:00",
"annualIncome": 25000.00,
"employerName": "Burnside Factory",
"emailAddress": "[email protected]",
"schoolName": "FSU",
"schoolOpeCode": "FSU",
"schoolGraduationYear": 1999,
"degreeType": "BSc",
"areaOfStudy": "Geology",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "1234 Possum Lane",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-6789",
"homePhoneNumber": "888-123-4567",
"workPhoneNumber": "888-987-6543",
"cellPhoneNumber": "888-453-7869",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"cosigners": [
{
"id": "355eb3ff-4a7e-4132-a24f-b1bf010e4598",
"ssn": "777777777",
"fullName": "Barney Rubble",
"dateOfBirth": "1966-10-21T00:00:00",
"annualIncome": 25000.00,
"employerName": "NA",
"emailAddress": "[email protected]",
"schoolName": "NA",
"schoolOpeCode": "NA",
"schoolGraduationYear": 1900,
"degreeType": "NA",
"areaOfStudy": "NA",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "1234 Possum Lane",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-6789",
"homePhoneNumber": "888-123-4567",
"cellPhoneNumber": "888-453-1234",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"rejectionReasons": [
{
"processingDate": "2024-08-01T16:24:02.8",
"ruleName": "Application Approval - Approved Loan Amount",
"errorMessage": "Failed Loan Amount check"
}
],
"originationDetails": {
"originationMonthlyPayment": 100.00,
"originationLoanTerm": 12,
"originationMaturityDate": "2025-05-30T00:00:00",
"originationFeePercentage": 11.23300,
"originationFeeAmount": 200.00
},
"fundImmediatelyOnApproval": true,
"immediateFundingInstructions": [
{
"amountToFund": 5555.55,
"routingNumber": "434898736",
"accountNumber": "234588767",
"accountName": "Bob Loblaw",
"accountType": "Checking",
"receivedDate": "2024-08-01T16:24:01.7850276"
},
{
"amountToFund": 2812.44,
"routingNumber": "435001237",
"accountNumber": "8722838",
"accountName": "Sam Smith",
"accountType": "Checking",
"receivedDate": "2024-08-01T16:24:01.7852321"
},
{
"amountToFund": 1234.55,
"routingNumber": "987612345",
"accountNumber": "9987876",
"accountName": "Bob Johnson",
"accountType": "Savings",
"receivedDate": "2024-08-01T16:24:01.7852304"
}
]
},
{
"id": "a64d4499-c0fd-408f-8db3-b1bf010eee8a",
"platformReferenceNumber": "ref2024-9876",
"applicationDate": "2024-06-11T00:00:00",
"requestedLoanAmount": 24000.00,
"approvedLoanAmount": 24000.00,
"apr": 12.45000,
"noteRate": 12.55000,
"loanAccountNumber": "HI1234-55",
"collateralCategory": "78 Impala",
"loanPurpose": "New toilet",
"defaultProbability": 1.44000,
"customRiskScore": "3AAA",
"customGrade": "3A",
"mlaLoan": true,
"ofacChecked": true,
"promotionDetails": {
"promotionMonths": 1,
"promotionExpiryDate": "2024-05-30T00:00:00",
"promotionTypeDescription": "1 month no interest"
},
"propertyDetails": {
"streetAddress": "7765 Main Street",
"city": "Springfield",
"state": "IL",
"zipCode": "12345-9876",
"cltv": 18.8800
},
"programId": "a3cf82e1-14ff-477a-9459-b1bf010a1b8e",
"applicationStatus": "Approved",
"borrowers": [
{
"id": "0b16b9f5-b5d7-4a39-9656-b1bf010eee96",
"ssn": "123011234",
"fullName": "Jessie MacCailein",
"dateOfBirth": "1958-11-10T00:00:00",
"annualIncome": 25000.00,
"employerName": "Acme Widgets",
"emailAddress": "[email protected]",
"schoolName": "FSU",
"schoolOpeCode": "FSU",
"schoolGraduationYear": 1980,
"degreeType": "BSc",
"areaOfStudy": "Mechanical Engineering",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "7765 Main Street",
"city": "Springfield",
"state": "IL",
"zipCode": "12345-9876",
"homePhoneNumber": "888-123-4567",
"workPhoneNumber": "888-987-6543",
"cellPhoneNumber": "888-453-7869",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"cosigners": [
{
"id": "03fc4e0b-8861-4ee7-87ee-b1bf010eee96",
"ssn": "777777777",
"fullName": "Katrina Gilchrist",
"dateOfBirth": "1961-03-13T00:00:00",
"annualIncome": 25000.00,
"employerName": "NA",
"emailAddress": "[email protected]",
"schoolName": "NA",
"schoolOpeCode": "NA",
"schoolGraduationYear": 1984,
"degreeType": "NA",
"areaOfStudy": "NA",
"deceased": false,
"housingStatus": "Rent",
"streetAddress": "7765 Main Street",
"city": "Springfield",
"state": "CO",
"zipCode": "12345-9876",
"homePhoneNumber": "888-123-4567",
"cellPhoneNumber": "888-453-1234",
"ficoScore": 710,
"debtToIncomeRatio": 1.44000
}
],
"rejectionReasons": [],
"originationDetails": {
"originationMonthlyPayment": 100.00,
"originationLoanTerm": 12,
"originationMaturityDate": "2025-05-30T00:00:00",
"originationFeePercentage": 1.6100,
"originationFeeAmount": 200.00
},
"fundImmediatelyOnApproval": false,
"loanId": "c58c02f4-ce15-40ca-a94a-4c5758e00c3c"
}
]
}
Response Data Element Details:
| Name | Type | Description |
|---|---|---|
| id | string | The application's Id |
| platformReferenceNumber | string | null | Platform Reference Number |
| applicationDate | date-time | Loan Application Date. |
| requestedLoanAmount | double | The amount of money that was requested |
| approvedLoanAmount | double | The amount of money that was approved |
| apr | double | The APR on the application |
| noteRate | double | The rate on the application |
| loanAccountNumber | string | null | The loan account number on the application |
| collateralCategory | string | null | The category that any collateral belongs to |
| loanPurpose | string | null | A description of the purpose of the loan |
| defaultProbability | double | The probability of default that was provided on the application |
| customRiskScore | string | null | The custom risk score provided on the application |
| customGrade | string | null | The custom grade provided on the application |
| mlaLoan | boolean | The Military Lending Act (MLA) status provided on the application |
| ofacChecked | boolean | The OFAC check status provided on the application |
| promotionDetails | object | Details about the promotion associated with a loan application. The object includes the following data: |
| > promotionMonths | int32 | The number of months that any promotion assigned to the application is valid for |
| > promotionExpiryDate | date-time | Date that any promotion assigned to the application will expire on |
| > promotionTypeDescription | string | null | Description of any promotion that has been assigned to the application |
| propertyDetails | object | Details about the property associated with the loan application. This is required if the program assigned to the loan application is for Home Improvement Loans. The object includes the following data: |
| > streetAddress | string | null | Street Address of the property associated with the application. Must be 255 characters long or less |
| > city | string | null | City of the property associated with the application. Must be 255 characters long or less |
| > state | string | null | State of the property associated with the application. Must be 2 characters long |
| > zipCode | string | null | Zip Code of the property associated with the application |
| > cltv | double | null | Combined loan-to-value (CLTV) ratio for the property |
| programId | string | The Combined loan-to-value (CLTV) ration provided on the application |
| applicationStatus | string | null | The current status of the application in the ingestion and approval process |
| borrowers | array of objects | null | List of all borrowers submitted on the application. The object includes the following data: |
| > id | string | The id of the borrower that was included on the application. This is unique to this application. If the same borrower is included on many different applications, each of those borrower entries will have a different id value |
| > ssn | string | null | The SSN of the borrower |
| > fullName | string | null | The full name of the borrower |
| > dateOfBirth | date-time | The date of birth of the borrower. |
| > annualIncome | double | The annual income of the borrower |
| > employerNmae | string | null | The name of the borrower's employer |
| > emailAddress | string | null | The email address of the borrower |
| > schoolName | string | null | The post secondary school the borrower attended |
| > schoolOpeCode | string | null | The Office of Post Secondary Education (OPE) code for the post secondary school the borrower attended |
| > schoolGraduationYear | int32 | null | The year that the borrower graduated from their post secondary school |
| > degreeType | string | null | The type of degree that the borrower received |
| > areaOfStudy | string | null | The borrower's area of study in post secondary school |
| > deceased | boolean | Indicates that the borrower is deceased |
| > housingStatus | string | Options are: Own Rent |
| > streetAddress | string | null | The street portion of the borrower's primary residence address |
| > city | string | null | The city portion of the borrower's primary residence address |
| > state | string | null | The state portion of the borrower's primary residence address |
| > zipCode | string | null | The Zip Code portion of the borrower's primary residence address |
| > homePhoneNumber | string | null | The home phone number of the borrower |
| > workPhoneNumber | string | null | The work phone number of the borrower |
| > cellPhoneNumber | string | null | The cell phone number of the borrower |
| > ficoScore | int32 | The borrower's FICO score |
| > debtToIncomeRatio | double | The borrower's debt to income ratio |
| cosigners | array of objects | null | List of all cosigners submitted on the application. The object includes the following data: |
| > id | string | The id of the cosigner that was included on the application. This is unique to this application. If the same cosigner is included on many different applications, each of those cosigner entries will have a different id value |
| > ssn | string | null | The SSN of the cosigner |
| > fullName | string | null | The full name of the cosigner |
| > dateOfBirth | date-time | The date of birth of the cosigner |
| > annualIncome | double | The annual income of the cosigner |
| > employerName | string | null | The name of the cosigner's employer |
| > emailAddress | string | null | The email of the cosigner |
| > schoolName | string | null | The post secondary school that the cosigner attended |
| > schoolOpeCode | string | null | The Office of Post Secondary Education (OPE) code for the post secondary school the cosigner attended |
| > schoolGraduationYear | int32 | null | The year that the cosigner graduated from their post secondary school |
| > degreeType | string | null | The type of degree that the cosigner received |
| > areaOfStudy | string | null | The cosigner's area of study in post secondary school |
| > deceased | boolean | Indicates if the cosigner id deceased |
| > housingStatus | string | Options are: Own Rent |
| > streetAddress | string | null | The street portion of the cosigner's primary residence address |
| > city | string | null | The city portion of the cosigner's primary residence address |
| > state | string | null | The state portion of the cosigner's primary residence address |
| > zipCode | string | null | the Zip Code portion of the cosigner's primary residence address |
| > homePhoneNumber | string | null | The home phone number of the cosigner |
| > workPhoneNumber | string | null | The work phone number of the cosigner |
| > cellPhoneNumber | string | null | The cell phone number of the cosigner |
| > ficoScore | int32 | The cosigner's FICO score |
| > debtToIncomeRatio | double | The cosigner's debt to income ratio |
| rejectionReasons | array of objects | null | List of any rejection reasons if the application was rejected and is in the Rejected Application Status state. The object contains the following data: |
| > processingDate | date-time | The date that the application processing occurred on. This value will in UTC |
| > ruleName | string | null | The rule name that caused the failure |
| > errorMessage | string | null | The error message associated with the failing rule |
| originationDetails | object | Details about the origination associated with the loan application. The object contains the following data: |
| > originationMonthlyPayment | double | Monthly payment for the application. Must be greater than 0 |
| > originationLoanTerm | int32 | Loan term for the application. Must be greater than 0 |
| > originationMaturityDate | date-time | Maturity date for the application. This value must be in the future when compared to the date the api is being called on |
| > originationFeePercentage | double | Fee percentage for the application |
| > originationFeeAmount | double | Fee amount for the application. This amount is subtracted from the ApprovedLoanAmount to determine the maximum amount of funds that can be disbursed on an application |
| fundImmediatelyOnApproval | boolean | Indicates that this application should be immediately funded using the ImmediateFundingInstructions when it is approved and converted from an application to a loan. (true; false) |
| immediateFundingInstructions | array of objects | List of funding instructions, that were submitted with the application, indicating what disbursements to perform if the Fund Immediately On Approval flag was set to true. The object contains the following data: |
| > amountToFund | double | Amount of money to disburse against the loan |
| > routingNumber | string | null | Routing number of the account the funds are disbursing to |
| > accountNumber | string | null | Account number that the funds are disbursing to |
| > accountName | string | null | The name on the account that the funds are disbursing to |
| > accountType | string | Options are: Checking Savings |
| > receivedDate | date-time | The name on the account that the funds are disbursing to |
| > platformReferenceNumber | string | null | The reference number provided by the API caller |
| loanId | string | null | The loan id that this application is associated with. This value will be null if the application has not been processed or has been rejected |
Error Handling:
Common errors will include:
400 – Bad Request
401 – Unauthorized
403 - Forbidden
422 – Unprocessable Content
500 – Internal Server Error
For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.
Updated about 1 month ago