# Apply for Spending Limit

<mark style="color:orange;">`POST`</mark> /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.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>customer-token</td><td>string</td><td>true</td><td>Customer's authentication token</td></tr><tr><td>x-version-override</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>x-consumer-custom-id</td><td>string</td><td>true</td><td>Consumer data with the format "channel:vendorId"</td></tr><tr><td>x-real-ip</td><td>string</td><td>false</td><td>senders ip address</td></tr><tr><td>customer-ip</td><td>string</td><td>false</td><td>customer ip address</td></tr></tbody></table>

### Body

You must provide a JSON payload.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>driversLicenseNumber</td><td>string</td><td>false</td><td>Driver Licence Number</td></tr><tr><td>driversLicenseState</td><td>string</td><td>false</td><td>Driver License State</td></tr><tr><td>gender</td><td>string</td><td>false</td><td>Gender</td></tr><tr><td>street1</td><td>string</td><td>true</td><td>The first line of the address</td></tr><tr><td>street2</td><td>string</td><td>false</td><td>The second line of the address</td></tr><tr><td>city</td><td>string</td><td>true</td><td>The city of the address</td></tr><tr><td>regionAbbr</td><td>string</td><td>true</td><td>The ISO 3166-2 state/province code of the address</td></tr><tr><td>postalCode</td><td>string</td><td>true</td><td>The postal code of the address</td></tr><tr><td>country</td><td>string</td><td>true</td><td>The ISO 3166-1 alpha-2 country code of the address</td></tr><tr><td>mobilePhone</td><td>phone</td><td>true</td><td>The mobile phone number of the customer</td></tr><tr><td>dateOfBirth</td><td>string</td><td>true</td><td>Date of Birth of the customer</td></tr><tr><td>ssn</td><td>string</td><td>true</td><td>Social Security Number of the customer</td></tr><tr><td>employmentInformation</td><td>object</td><td>true</td><td>N/A</td></tr><tr><td>employmentInformation.name</td><td>string</td><td>false</td><td>Name of Employer</td></tr><tr><td>employmentInformation.phone</td><td>phone</td><td>false</td><td>The work phone number of the customer</td></tr><tr><td>employmentInformation.monthlyIncome</td><td>number</td><td>true</td><td>Monthly income from employment before taxes are deducted (Dollar amount)</td></tr><tr><td>employmentInformation.payFrequency</td><td>string</td><td>true</td><td>Allowed values: weekly, biweekly, semimonthly, monthly, yearly, none</td></tr><tr><td>employmentInformation.lastPayDate</td><td>string</td><td>false</td><td>timestamp when last pay date</td></tr><tr><td>employmentInformation.nextPayDate</td><td>string</td><td>false</td><td>timestamp when next pay date</td></tr><tr><td>bankAccount</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>bankAccount.routing</td><td>string</td><td>true</td><td>Bank account routing number</td></tr><tr><td>bankAccount.account</td><td>string</td><td>true</td><td>Bank account number</td></tr><tr><td>bankAccount.type</td><td>string</td><td>true</td><td>Account type. Allowed values: checking, savings</td></tr><tr><td>fraudCheck</td><td>array</td><td>false</td><td>N/A</td></tr><tr><td>fraudCheck[].providerName</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>fraudCheck[].score</td><td>number</td><td>false</td><td>N/A</td></tr><tr><td>fraudCheck[].status</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation</td><td>array</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation[].type</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation[].expirationDate</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation[].lastFour</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation[].firstSix</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation[].cardType</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation[].tokens</td><td>array</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation[].tokens[].gateway</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation[].tokens[].token</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>cardInformation[].validation</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>deviceFingerprint</td><td>string</td><td>false</td><td>Long base64-encoded string</td></tr><tr><td>expectedPurchaseAmount</td><td>number</td><td>false</td><td>Requested spending limit for customer purchase</td></tr><tr><td>optInMarketing</td><td>boolean</td><td>false</td><td>The customer's approval for opt-in into FlexShopper marketing and promotions</td></tr><tr><td>additionalData</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>additionalData.storeEmployeeId</td><td>string</td><td>false</td><td>Store Employee Id</td></tr><tr><td>additionalData.commonApplicationKey</td><td>object</td><td>false</td><td>Synchrony ID</td></tr><tr><td>additionalData.firstGlance</td><td>boolean</td><td>false</td><td>Determines if we are the first used in the cascade</td></tr></tbody></table>

## 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.

{% tabs %}
{% tab title="200" %}

```javascript
{
    "data": {
        "userId": "1234-asdf-4321-fdsa",
        "firstName": "John",
        "lastName": "Doe",
        "email": "Doe",
        "createdAt": "2018-03-19T15:51:27.080Z",
        "transactions": [
            {
                "id": "asdf-1234-fdsa-4321",
                "createdAt": "2018-12-21",
                "lease": {
                    "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
                    "status": "signed"
                }
            }
        ],
        "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"
    }
}
```

{% endtab %}

{% tab title="400" %}

```javascript
{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email ex@example.com",
        "data": {}
    }
}
```

{% endtab %}

{% tab title="404" %}

```javascript
{
    "error": {
        "statusCode": 404,
        "code": "LeaseNotFound",
        "message": "The lease requested was not found",
        "data": {}
    }
}
```

{% endtab %}

{% tab title="409" %}

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

{% endtab %}

{% tab title="502" %}

```javascript
{
    "error": {
        "statusCode": 502,
        "code": "BadGateway",
        "message": "Gateway returned status code",
        "data": {}
    }
}
```

{% endtab %}
{% endtabs %}

### Schema

The response's schema is outlined below.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.userId</td><td>string</td><td>true</td><td>User Id</td></tr><tr><td>data.firstName</td><td>string</td><td>true</td><td>User's first name</td></tr><tr><td>data.lastName</td><td>string</td><td>true</td><td>User's last name</td></tr><tr><td>data.email</td><td>string</td><td>true</td><td>User's last name</td></tr><tr><td>data.createdAt</td><td>string</td><td>true</td><td>User's creation date</td></tr><tr><td>data.transactions</td><td>array</td><td>false</td><td>N/A</td></tr><tr><td>data.transactions[].id</td><td>string</td><td>true</td><td>Transaction Id</td></tr><tr><td>data.transactions[].createdAt</td><td>string</td><td>true</td><td>Transaction's creation date</td></tr><tr><td>data.transactions[].lease</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.transactions[].lease.id</td><td>string</td><td>true</td><td>lease identifier</td></tr><tr><td>data.transactions[].lease.status</td><td>string</td><td>true</td><td>N/A</td></tr><tr><td>data.decision</td><td>object</td><td>true</td><td>N/A</td></tr><tr><td>data.decision.applicationId</td><td>string</td><td>true</td><td>Application Id</td></tr><tr><td>data.decision.prequalId</td><td>string</td><td>false</td><td>prequalification ID</td></tr><tr><td>data.decision.approved</td><td>boolean</td><td>true</td><td>Determines if the customer was approved or not(To be deprecated)</td></tr><tr><td>data.decision.status</td><td>string</td><td>true</td><td>Determines the customer application status. Possible values: approved, pending, failed</td></tr><tr><td>data.decision.spendingLimit</td><td>number</td><td>true</td><td>The spending limit approved</td></tr><tr><td>data.decision.availableBalance</td><td>number</td><td>false</td><td>Available balance to spend</td></tr><tr><td>data.decision.availableWeeklySpending</td><td>number</td><td>false</td><td>The available amount to spend in a weekly basis</td></tr><tr><td>data.decision.createdAt</td><td>string</td><td>true</td><td>Decision's creation date</td></tr><tr><td>data.decision.waterfallSuppressionFlags</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.decision.waterfallSuppressionFlags.suppressWaterfallToUOwn</td><td>boolean</td><td>false</td><td>Determines if uown needs to be skipped)</td></tr><tr><td>data.decision.vantageHighScore</td><td>boolean</td><td>false</td><td>N/A</td></tr><tr><td>data.decision.funnel</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>data.verificationStatus</td><td>string</td><td>true</td><td>Verification status the possible status are: pending, failed, succeeded</td></tr></tbody></table>