API Reference
API Reference
Start typing to search…

/application/{id} - GET

get https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application/

Retrieve a specific loan application using its Id value.

Path Params
uuid
required

Format - uuid.

Responses

Response body
object
uuid

The application's Id

string | null

Platform Reference Number

date-time

Loan Application Date.

double

The amount of money that was requested by the customer when they first applied

double

The maximum amount of money that this application qualifies for

double

The loan amount that will appear on the loan agreement

double | null

The expected proceeds to be disbursed

date-time | null

A UTC datetime representing when the partner approved this application in their system/process

double

The APR on the application

double

The rate on the application

string | null

The loan account number on the application

string | null

The category that any collateral belongs to

string | null

A description of the purpose of the loan

double

The probability of default that was provided on the application

string | null

The custom risk score provided on the application

string | null

The custom grade provided on the application

boolean

The Military Lending Act (MLA) status provided on the application

boolean

The OFAC check status provided on the application

promotionDetails
object

Details about the promotion associated with a loan application

int32
required

The number of months that any promotion assigned to the application is valid for

date-time
required

Date that any promotion assigned to the application will expire on

string
required
length ≥ 1

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

string
required
length ≥ 1

Street Address of the property associated with the application. Must be 255 characters long or less

string
required
length ≥ 1

City of the property associated with the application. Must be 255 characters long or less

string
required
length ≥ 1

State of the property associated with the application. Must be 2 characters long

string
required
length ≥ 1

Zip Code of the property associated with the application

double
required

Combined loan-to-value (CLTV) ratio for the property

string
required

Other SingleFamily Duplex Triplex Apartment Condominium Undeveloped Agriculture Commercial MobileHome ManufacturedHome

int32
required

Total number of units at this property

double | null

Property valuation determined by an automated valuation model

double | null

Property valuation determined by a manual modeling process

double | null

Confidence score for the property valuation determined by the automated valuation model

double | null

Balance outstanding on this property's mortgage

uuid

The Combined loan-to-value (CLTV) ration provided on the application

string | null

The current status of the application in the ingestion and approval process

array of objects | null

List of all borrowers submitted on the application

borrowers
object
uuid

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

string | null

The SSN of the borrower

string | null

The full name of the borrower

date-time

The date of birth of the borrower.

double

The annual income of the borrower

string | null

The name of the borrower's employer

string | null

The email address of the borrower

string | null

The post secondary school the borrower attended

string | null

The Office of Post Secondary Education (OPE) code for the post secondary school the borrower attended

int32 | null

The year that the borrower graduated from their post secondary school

string | null

The type of degree that the borrower received

string | null

The borrower's area of study in post secondary school

boolean

Indicates that the borrower is deceased

string

Own Rent

string | null

The street portion of the borrower's primary residence address

string | null

The city portion of the borrower's primary residence address

string | null

The state portion of the borrower's primary residence address

string | null

The Zip Code portion of the borrower's primary residence address

string | null

The home phone number of the borrower

string | null

The work phone number of the borrower

string | null

The cell phone number of the borrower

int32

The borrower's FICO score

double

The borrower's debt to income ratio

int32

Number of credit inquiries for this person.

int32

Number of non-traditional credit inquiries for this person.

int32

Number of mortgage delinquencies for this person.

int32

Number of payments later than 30 days for this person.

int32

Number of derogatory remarks for this person.

boolean

Has this person had a bankruptcy.

double | null

Borrower's amount of Debt.

array of objects | null

List of all cosigners submitted on the application

cosigners
object
uuid

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

string | null

The SSN of the cosigner

string | null

The full name of the cosigner

date-time

The date of birth of the cosigner

double

The annual income of the cosigner

string | null

The name of the cosigner's employer

string | null

The email of the cosigner

string | null

The post secondary school that the cosigner attended

string | null

The Office of Post Secondary Education (OPE) code for the post secondary school the cosigner attended

int32 | null

The year that the cosigner graduated from their post secondary school

string | null

The type of degree that the cosigner received

string | null

The cosigner's area of study in post secondary school

boolean

Indicates if the cosigner id deceased

string

Own Rent

string | null

The street portion of the cosigner's primary residence address

string | null

The city portion of the cosigner's primary residence address

string | null

The state portion of the cosigner's primary residence address

string | null

the Zip Code portion of the cosigner's primary residence address

string | null

The home phone number of the cosigner

string | null

The work phone number of the cosigner

string | null

The cell phone number of the cosigner

int32

The cosigner's FICO score

double

The cosigner's debt to income ratio

int32

Number of credit inquiries for this person.

int32

Number of non-traditional credit inquiries for this person.

int32

Number of mortgage delinquencies for this person.

int32

Number of payments later than 30 days for this person.

int32

Number of derogatory remarks for this person.

boolean

Has this person had a bankruptcy.

double | null

Cosigner's amount of Debt.

array of objects | null

List of any rejection reasons if the application was rejected and is in the Rejected Application Status state

rejectionReasons
object
date-time

The date that the application processing occurred on. This value will in UTC

string | null

The rule name that caused the failure

string | null

The error message associated with the failing rule

boolean

Indicates that immediate funding was requested when the application was submitted

array of objects | null

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

immediateFundingInstructions
object
double

Amount of money to disburse against the loan

string | null

Routing number of the account the funds are disbursing to

string | null

Account number that the funds are disbursing to

string | null

The name on the account that the funds are disbursing to

string

Checking Savings

date-time

The date that the funding instruction was received on. This value will be in UTC

string | null

The reference number provided by the API caller

uuid | 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

array of strings | null

List of AanReasons submitted for this application.

aanReasons
array of objects | null

List of Contractors submitted for this application

contractors
object
string | null

Contractor's name

string | null

Contractor's EIN

boolean | null

Flag indicating that the application is a result of a counteroffer process being engaged

double

Monthly payment for the application

int32

Loan term for the application input as months

date-time

Maturity date for the application

double

Merchant discount rate percentage for the application

double

Merchant discount rate amount (in dollars) for the application

double | null

The factor used to calculate the monthly payment

Updated 5 months ago

Did this page help you?
Language

Updated 5 months ago

Did this page help you?