Initiate Application
Applies for a new spending limit with an existing customer account.
/users/me/apply
POST
https://apis.sandbox.flexshopper.com/v3/users/me/apply
Initiates a customer's application
Headers
customer-token
string
Customer's authentication token
Authorization
string
Authentication token
x-real-ip
string
Sender's IP address
customer-ip
string
Customer's IP address
Request Body
additionalData.firstGlance
boolean
Determines if we are the first used in the cascade
additionalData.storeEmployeeId
string
Employee Id on the store conducting the customer application
additionalData.commonApplicationKey
object
Common Application Key
additionalData
object
Additional retailer data
gender
string
Customer gender. Allowed values: male or female
driversLicenseNumber
string
Driver License Number
driversLicenseState
string
Driver License State
bankAccount.routing
string
Bank account routing number
bankAccount.account
string
Bank account number
bankAccount.type
string
Account type. Allowed values: checking, savings
bankAccount
object
Customer Bank Account Information
employmentInformation.nextPay
string
Next pay date in ISO 8601 format (e.g. 2000-01-30)
employmentInformation.lastPayDate
string
Last pay date in ISO 8601 format (e.g. 2000-01-30)
employmentInformation.payFrquency
string
Allowed values: weekly, biweekly, semimonthly, monthly, yearly, none
employmentInformation.monthlyIncome
number
Monthly income from employment before taxes are deducted (Dollar amount)
employmentInformation.phone
string
The work phone of the customer
employmentInformation.name
string
Name of Employer
employmentInformation
object
Employment Information
expectedPurchaseAmount
number
Requested spending limit for the customer purchase
optInMarketing
boolean
The customer's approval for opt-in into FlexShopper marketing and promotions
street1
string
From the customer's address.
street2
string
From the customer's address.
city
string
The customer's city.
regionAbbr
string
The two ISO 3166-2 letter abbreviation (e.g. NC, FL) of the customer's state.
postalCode
string
The customer's postal code.
country
string
The ISO 3166-1 2 letter country code (e.g. US, CA) of the customer's country.
mobilePhone
string
The customer's mobile phone number.
dateOfBirth
string
The customer's date of birth (e.g. 1980-10-18).
ssn
string
The customer's Social Security Number.
deviceFingerprint
string
A base64-encoded string to identify the device used for application.
fraudCheck
array
Fraud check result info
fraudCheck[].providerName
string
Fraud check name
fraudCheck[].score
string
Fraud check score
fraudCheck[].status
string
Fraud check result
cardInformation
array
Card related info
cardInformation[].type
string
Card type (e.g. debit, credit)
cardInformation[].expirationDate
string
Card expiration date in YYYY-MM format (e.g. 2000-12)
cardInformation[].lastFour
string
Card last four digits
cardInformation[].firstSix
string
Card first six digits
cardInformation[].cardType
string
Card brand (e.g. mastercard, visa)
cardInformation[].tokens
array
Card token array
cardInformation[].tokens[].gateway
string
Card token gateway name
cardInformation[].tokens[].token
string
Card token
cardInformation[].validation
object
Card validation object
Payload example
If the customer has already applied, an error with code 409 will be returned.
Last updated