Prequalification Apply Flow

For preqaulification apply flow, use these prequal start and complete endpoints.

Prequalification Start

POST https://apis.sandbox.flexshopper.com/v3/users/prequal/start/lease

This endpoint provides a prequalification lease decision.

Headers

Name	Type	Description
Authorization	string	API Auth token

Request Body

Name	Type	Description
mobilePhone	string	Consumer's mobile phone number
optInMarketing	boolean	Consumer has opted in to receive email communication from FlexShopper
firstName	string	Consumer's first name
lastName	string	Consumer's last name
email	string	Consumer's email
password	string	Set consumer password for future visits
street1	string	Consumer's address
street2	string	Consumer's address
city	string	Consumer's city
regionAbbr	string	ISO 3166-2 letter abbreviation of state (eg NC, FL)
postalCode	string	Consumer's postal code
country	string	ISO-3166-1 2 letter country code (ie US)
employmentInformation	object	Employment Information Object
employmentInformation.payFrequency	string	Allowed values: weekly, biweekly, semimonthly, monthly, yearly, none
employmentInformation.monthlyIncome	integer	Gross monthly income in dollars
dateOfBirth	string	Consumer's date of birth YYYY-MM-DD
ssn	string	Consumer's Social Security Number
ipAddress	string	Device IPv4 provided for online applications

200 Successfully prequal decisioned.

{
	"data": {
		"prequalId": "5a319511a86980001d602095",
		"decision": {
			"applicationId": "d363955e-3110-11e8-a373-5e7783c1a76e",
			"approved": true,
			"status": "approved",
			"limit": 1300,
			"availableLimit": 1200,
			"availableWeeklyLimit": 120,
			"createdAt": "2018-03-19T15:51:27.080Z"
		},
	"verificationStatus": "succeeded"
	}
}

400 Malformed request.

{
    "error": {
        "statusCode": 400
    }
}

409 User already exists

{
    "error": {
        "statusCode": 409,
        "code": "UserAlreadyExists",
        "message": "The user already exists",
        "data": {}
    }
}

Prior to submitting ACH information to the Prequalification Complete endpoint, the ACH routing number should be validated using FlexShopper's Validate Routing Number endpoint.

Prequalification Complete (full application)

POST https://apis.sandbox.flexshopper.com/v3/users/prequal/complete/lease

Use the prequalId value returned by Prequalification Start endpoint and append ACH data to complete the consumer application.

Headers

Name	Type	Description
Authorization	string	API Auth token

Request Body

Name	Type	Description
bankAccount.routing	string	ACH ABA routing number
bankAccount.account	string	ACH account Number
ipAddress	string	Device's IPv4 IIP Address
prequalId	string	ID representing the prequal decision that was returned by the prequal/start endpoint.

200 Returns a completed application

	{
		"data": {
		"customerAuthToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YTk...",
		"userId": "5a319511a86980001d602095",
		"decision": {
			"applicationId": "d363955e-3110-11e8-a373-5e7783c1a76e",
			"approved": true,
			"status": "approved",
			"limit": 1300,
			"availableLimit": 1200,
			"availableWeeklyLimit": 120,
			"createdAt": "2018-03-19T15:51:27.080Z"
		},
	"verificationStatus": "succeeded"
	}
}

400 Malformed request.

{
    "error": {
        "statusCode": 400
    }
}

404 Prequalification not found.

{
    "error": {
        "statusCode": 404,
        "code": "PrequalificationNotFound",
        "message": "The prequalification does not exist",
        "data": {}
    }
}