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
Name | Type | Description |
---|---|---|
customer-token | string | Customer's authentication token |
Authorization | string | Authentication token |
Request Body
Name | Type | Description |
---|---|---|
additionalData.firstGlance | string | 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.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 | string | Requested spending limit for the customer purchase |
optInMarketing | string | 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. |
payFrequency | string | The customer's pay frequency; one of: weekly, biweekly, semimonthly, monthly, none. |
deviceFingerprint | string | A base64-encoded string to identify the device used for application. |
Payload example
If the customer has already applied, an error with code 409 will be returned.
Last updated