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	Required	Description
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

Name	Type	Required	Description
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

200

{
  "data": {
    "userId": "1234-asdf-4321-fdsa",
    "firstName": "John",
    "lastName": "Doe",
    "email": "Doe",
    "createdAt": "2018-03-19T15:51:27.080Z",
    "decision": {
      "applicationId": "d363955e-3110-11e8-a373-5e7783c1a76e",
      "approved": true,
      "status": "approved",
      "spendingLimit": 1300,
      "availableBalance": 1200,
      "availableWeeklySpending": 120,
      "createdAt": "2018-03-19T15:51:27.080Z",
      "waterfallSuppressionFlags": {
        "suppressWaterfallToUOwn": "null"
      },
    },
    "verificationStatus": "succeeded"
  }
}

409

{
  "error": {
    "statusCode": 409,
    "code": "CustomerAlreadyApplied",
    "message": "The customer already applied",
    "data": {}
  }
}

Payload example

{
  "driversLicenseNumber": "I234567800",
  "driversLicenseState": "FL",
  "gender": "female",
  "street1": "123 Test Dr.",
  "street2": "Apt 2",
  "city": "Hollywood",
  "regionAbbr": "FL",
  "postalCode": "33021",
  "country": "US",
  "mobilePhone": "6514447773",
  "dateOfBirth": "1998-03-23",
  "ssn": "888776666",
  "employmentInformation": {
    "name": "Flexshopper",
    "phone": "6514447773",
    "monthlyIncome": 1250,
    "payFrequency": "weekly",
    "lastPayDate": "2000-01-01",
    "nextPayDate": "2000-01-14"
  },
  "cardInformation": [
    {
      "type": "debit",
      "expirationDate": "2000-01",
      "lastFour": "123",
      "cardType": "mastercard",
      "tokens": [
        {
          "gateway": "gatewayName",
          "token": "gatewayToken"
        }
      ],
      "validation": { "validationkey": "validationValue" }
    }
  ],
  "bankAccount": {
    "routing": "888776666",
    "account": "3483898238239",
    "type": "checking"
  },
  "deviceFingerprint": "...long base64-encoded string",
  "expectedPurchaseAmount": 1200,
  "optInMarketing": true,
  "additionalData": {
    "storeEmployeeId": "123",
    "commonApplicationKey": {
      "synchrony": "123"
    },
    "firstGlance": true
  },
  "fraudCheck": [
    {
      "providerName": "experian",
      "score": "14.4244",
      "status": "success"
    }
  ]
}

If the customer has already applied, an error with code 409 will be returned.