FlexShopper API
3.0
FlexShopper API
3.0
  • Introduction
  • Integration Guides
    • Medusa
    • Payment Plugin
  • Customer
    • Verify User Exists
    • Deeply Verify User Exists
    • Create User
    • Get Users
    • Get User
    • Create Authorization Token
    • Add Payment Method
      • Get LoanPaymentPro Child Key
      • Get Clover PKMS Key
  • Decision
    • Apply for Spending Limit
  • Lease
    • Create Lease
    • Get Transactions
    • Get Lease By ID
    • Get Transaction By ID
    • Sign Lease
    • Finalize Lease
    • Cancel Items
    • Return Items
    • Confirm Shipment
    • Confirm Receipt
Powered by GitBook
On this page
  • Request
  • Headers
  • Body
  • Response
  • Samples
  • Schema

Was this helpful?

Export as PDF
  1. Decision

Apply for Spending Limit

Creates a new lease application for an existing user account

POST /v3/users/me/apply

Request

The details below help you form your HTTP requests to this endpoint.

Headers

You may need to provide specific headers.

Name
Type
Required
Description

customer-token

string

Customer's authentication token

x-version-override

string

N/A

x-consumer-custom-id

string

Consumer data with the format "channel:vendorId"

x-real-ip

string

senders ip address

customer-ip

string

customer ip address

Body

You must provide a JSON payload.

Name
Type
Required
Description

driversLicenseNumber

string

Driver Licence Number

driversLicenseState

string

Driver License State

gender

string

Gender

street1

string

The first line of the address

street2

string

The second line of the address

city

string

The city of the address

regionAbbr

string

The ISO 3166-2 state/province code of the address

postalCode

string

The postal code of the address

country

string

The ISO 3166-1 alpha-2 country code of the address

mobilePhone

phone

The mobile phone number of the customer

dateOfBirth

string

Date of Birth of the customer

ssn

string

Social Security Number of the customer

employmentInformation.name

string

Name of Employer

employmentInformation.phone

phone

The work phone number of the customer

employmentInformation.monthlyIncome

number

Monthly income from employment before taxes are deducted (Dollar amount)

employmentInformation.payFrequency

string

Allowed values: weekly, biweekly, semimonthly, monthly, yearly, none

employmentInformation.lastPayDate

string

timestamp when last pay date

employmentInformation.nextPayDate

string

timestamp when next pay date

bankAccount.routing

string

Bank account routing number

bankAccount.account

string

Bank account number

bankAccount.type

string

Account type. Allowed values: checking, savings

fraudCheck

array

N/A

cardInformation

array

N/A

deviceFingerprint

string

Long base64-encoded string

expectedPurchaseAmount

number

Requested spending limit for customer purchase

optInMarketing

boolean

The customer's approval for opt-in into FlexShopper marketing and promotions

additionalData.storeEmployeeId

string

Store Employee Id

additionalData.firstGlance

boolean

Determines if we are the first used in the cascade

Response

The details below help you understand the responses you could get from this endpoint.

Samples

Below are samples of responses, with tabs corresponding to returned status code.

{
    "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",
            "prequalId": "5a319511a86980001d602095",
            "approved": true,
            "status": "approved",
            "spendingLimit": 1300,
            "availableBalance": 1200,
            "availableWeeklySpending": 120,
            "createdAt": "2018-03-19T15:51:27.080Z",
            "waterfallSuppressionFlags": {
                "suppressWaterfallToUOwn": false
            },
            "vantageHighScore": true,
            "funnel": "tireagent"
        },
        "verificationStatus": "succeeded"
    }
}
{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email ex@example.com",
        "data": {}
    }
}
{
    "error": {
        "statusCode": 404,
        "code": "LeaseNotFound",
        "message": "The lease requested was not found",
        "data": {}
    }
}
{
    "error": {
        "statusCode": 409,
        "code": "UserAlreadyExists",
        "message": "The user already exists",
        "data": {}
    }
}
{
    "error": {
        "statusCode": 502,
        "code": "BadGateway",
        "message": "Gateway returned status code",
        "data": {}
    }
}

Schema

The response's schema is outlined below.

Name
Type
Required
Description

data.userId

string

User Id

data.firstName

string

User's first name

data.lastName

string

User's last name

data.email

string

User's last name

data.createdAt

string

User's creation date

data.transactions

array

N/A

data.decision.applicationId

string

Application Id

data.decision.prequalId

string

prequalification ID

data.decision.approved

boolean

Determines if the customer was approved or not(To be deprecated)

data.decision.status

string

Determines the customer application status. Possible values: approved, pending, failed

data.decision.spendingLimit

number

The spending limit approved

data.decision.availableBalance

number

Available balance to spend

data.decision.availableWeeklySpending

number

The available amount to spend in a weekly basis

data.decision.createdAt

string

Decision's creation date

data.decision.waterfallSuppressionFlags.suppressWaterfallToUOwn

boolean

Determines if uown needs to be skipped)

data.decision.vantageHighScore

boolean

N/A

data.decision.funnel

string

N/A

data.verificationStatus

string

Verification status the possible status are: pending, failed, succeeded

PreviousGet Clover PKMS KeyNextCreate Lease

Last updated 4 days ago

Was this helpful?