/application - POST

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

Creates a new loan application in the system. Creating an application will initiate the approval process. If that process is successful the application will be converted to a loan.

Body Params

platformReferenceNumber

string

required

length ≥ 1

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

required

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

required

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

maximumApprovedLoanAmount

double

required

The maximum amount of money that this application qualifies for

loanAmount

double

required

The loan amount that will appear on the loan agreement

netFundingAmount

double | null

The expected proceeds to be disbursed

partnerLoanApprovalDate

date-time | null

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

apr

double

required

The APR in a decimal format. Must be greater than 0. 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

required

length ≥ 1

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

required

Is the loan application governed by the Military Lending Act (MLA)

ofacChecked

boolean

required

Have the borrowers and cosigners been OFAC checked by the API caller

promotionDetails

object

Details about the promotion associated with a loan application

borrowers

array of objects

required

List of all borrowers

borrowers*

cosigners

array of objects | null

List of all cosigners

cosigners

programId

uuid

required

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

required

length ≥ 1

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

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

immediateFundingInstructions

aanReasons

array of strings | null

List of AanReasons collected for this application. Maximum length for each AAN Reason is 255 characters. Anything beyond that will be trimmed

aanReasons

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

contractors

array of objects | null

List of Contractors associated with this application. This is required if the application program is a Home Improvement Loan

contractors

resultOfCounterOfferProcess

boolean | null

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

monthlyPayment

double

Monthly payment for the application. Must be greater than 0

termLength

int32

required

Loan term for the application input as months. Must be greater than 0

maturityDate

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

merchantDiscountRatePercentage

double

required

Merchant discount rate (MDR) percentage for the application. If the value is six point five percent, provide 6.5. If there is no MDR enter 0.00.

merchantDiscountRateAmount

double

required

Merchant discount rate (MRD) amount (in dollars) for the application. This amount is subtracted from the ApprovedLoanAmount to determine the maximum amount of funds that can be disbursed on an application. If there is no MDR enter 0.00

paymentFactor

double | null

The factor used to calculate the monthly payment

Headers

x-idempotency-key

uuid

required

Format - uuid. Unique request idenitfier for idempotency.

Responses

Language


xxxxxxxxxx
13
1
curl --request POST \
2
     --url https://cubi-sandbox-api.customersbank.com/consumerlending/v1/application \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json' \
5
     --data '
6
{
7
  "isMlaLoan": true,
8
  "ofacChecked": true,
9
  "propertyDetails": {
10
    "propertyType": "Other"
11
  }
12
}
13
'


xxxxxxxxxx
 
1
{
2
  "id": "string",
3
  "immediateFundingInstructions": [
4
    {
5
      "platformReferenceNumber": "string",
6
      "fundingInstructionId": "string"
7
    }
8
  ]
9
}

202Accepted

400BadRequest

401Unauthorized

403Forbidden

422UnprocessableEntity

500InternalServerError