---
title: "Update lease application"
method: POST
path: "/application/update"
tags: ["Application"]
---

# Update lease application

`POST /application/update`

Receives PreQual, bank, and card information required to decision a lease application. Can return an Approved, Denied, or PreApproved.

## Request body

- App — Lease Application submission details
  - `store` Store — An object that contains the details of the Merchant and their Store.
    - `progressiveMerchantId` integer — The Progressive supplied ID that designates your Progressive store number.
    - `merchantStoreId` string, nullable — This value is supplied by your organization. It is the value from your system which represents an individual store location. This information must be cross referenced to the Progressive System.
    - `salesAssociate` string, nullable — Store sales associate name/ID that is entering the lease application.
    - `merchantApplicationIdentifier` string, nullable — This is a store-specific field for passing a Merchant application's unique identifier.
    - `merchantTerminalId` string, nullable — Store terminal Id number, to be used in scenarios where a store's POS system is interacting with the endpoint.
    - `isNotifyStoreOnApplication` boolean — The Id of the application to patch or update.
    - `source` 'NotSet' | 'ProgCentral' | 'Tanc' | 'MyAccount' | 'CommerceApi' | 'Pos' | 'ProgAnywhere' | 'ProgConnect' | 'ProgMarketplaceSingleCart' — The Cart Source
  - `disclosureCode` integer — This code represents the electronic disclosure code sent to a customer's mobile device. If not using electronic disclosures, this data element can be null.
  - `languagePreference` 'En' | 'Es' — This is used to generate the lease agreement and other communications from Progressive in the language preference provided. Valid entires include en (english) and es (spanish).
  - `marketingOptIn` boolean — This is a Boolean value indicating if the customer has consented to receive Marketing communications from Progressive Leasing.
  - `smsOptIn` boolean — If a store is set up to send a SMS message when a cart is submitted, and the value from this field is false, a customer will not receive a SMS message to sign their lease agreement. This will override the store setting.
  - `threatMetrixId` string, nullable — The unique ThreatMetrix Identification for the given customer. If you aren't using ThreatMetrix, leave empty.
  - `applicationSource` string, nullable — Identifies the primary integration source of the application. This value is provided by Progressive Leasing.
  - `customer` Customer — An object that contains the details of the Customer.
    - `merchantCustomerId` string, nullable — This value is supplied by your organization. It is the value from your system which represents a customer.
    - `firstName` string, nullable — The first name of the customer.
    - `lastName` string, nullable — The last name of the customer.
    - `ssn` string, nullable — The customer's social security or ITIN number. This is a numeric 9-digit field. The social security number must be entered without formatting.
    - `birthdate` string, date-time — Customer's date of birth. This is a required field to validate the customer is of legal age (18 years or older).
    - `homePhone` string, nullable — Customer's home phone number including area code. This field cannot start with 0 or 1 and must only contain 10 digits.
    - `cellPhone` string, nullable — Customer's cell phone number including area code. This field cannot start with 0 or 1 and must only contain 10 digits.
    - `emailAddress` string, nullable — Customer's email address.
    - `incomeSourceType` string, nullable — Customer's income source type.
    - `incomeName` string, nullable — Customer's employer or name of income source.
    - `grossIncomeMonthly` integer — Customer's monthly gross income.
    - `paymentFrequency` PaymentFrequency — An object that contains information about the customer's payment schedule.
      - `payFrequency` 'Weekly' | 'BiWeekly' | 'SemiMonthly' | 'Monthly' — Indicates a customer's pay frequency. Valid entries include Weekly, Biweekly (e.g. every other Friday), SemiMonthly (e.g. the 5th and 20th of each month), Monthly.
      - `nextPayDate` string, date-time — Date of the customer's next paycheck.
      - `lastPayDate` string, date-time — Date of the customer's last paycheck.
    - `creditCard` CreditCard — An object that contains the details of a customer's credit card.
      - `cardNumber` string, nullable — The credit card number (PAN). Required only when CardBin are not submitted. Supports encryption, please speak with your integration specialist to learn how to encrypt your data.
      - `cardBin` string, nullable — The credit card BIN represents the first 6 digits of a credit card. If this method is used, the remaining credit card data fields are not required. BIN information can always be included if known.
      - `cvv` string, nullable — Card Verification Value (CVV).
      - `cardToken` string, nullable
      - `expirationDate` string, nullable — Credit card expiration date.
      - `expirationMonth` integer, nullable — The expiration month, 1-12.
      - `expirationYear` integer, nullable — The expiration year in YY format.
      - `firstNameOnCard` string, nullable — First name on credit card.
      - `lastNameOnCard` string, nullable — Last name on credit card.
      - `billingAddress` Address — Address Information Details
        - `streetAddress1` string, nullable — The customer's first line of the street address.
        - `streetAddress2` string, nullable — The customer's second line of the street address.
        - `city` string, nullable — The customer's city.
        - `state` string, nullable — The customer's two-digit state code.
        - `zip` string, nullable — The customer's postal code.
      - `isPrequalified` boolean, nullable — Whether or not the application this card is associated with is prequalified, if applicable.
    - `identification` Identification — Customer Identification.
      - `type` 'DL' | 'SI' | 'MI' | 'UP' | 'RA' | 'Other' — ID Type. Valid entries include DL (Driver's License), SI (State Identification Card), MI (Military Identification Card), UP (U.S. Passport), RA (Resident Alien Card), and Other.
      - `state` string, nullable — The state of ID issuance.
      - `number` string, nullable — The identification number for a given Identification Type e.g. Driver License Number.
    - `homeAddress` Address — Address Information Details
      - `streetAddress1` string, nullable — The customer's first line of the street address.
      - `streetAddress2` string, nullable — The customer's second line of the street address.
      - `city` string, nullable — The customer's city.
      - `state` string, nullable — The customer's two-digit state code.
      - `zip` string, nullable — The customer's postal code.
  - `bank` Bank — Bank Information
    - `routingNumber` string, nullable
    - `accountNumber` string, nullable
  - `custom` CustomData — This object contains custom application fields as required by different flows. Your Implementation Manager will let you know if there is anything required in this section.
    - `keys` CustomDataField[], nullable — A collection of custom key-value pairs, used to include additional information in the request.
      - `key` string, nullable — The name of the custom field value being provided.
      - `value` string, nullable — The value of the custom field being provided.
  - `leaseSource` LeaseSource — Lease source integration details.
    - `company` string, nullable — The name of the company.
    - `brand` string, nullable — The name of the brand.
    - `flow` string, nullable — The name of the application flow.
    - `integrator` string, nullable — The name of the integration.
  - `applicationId` integer — The Id of the application to patch or update.

## Response `200`

Updated

- AppStatus — Lease application submission response
  - `applicationId` string, nullable — This is the Account Number (AKA Lease ID) as assigned by Progressive Leasing.
  - `status` string, nullable — Defines the current status of an Application. Valid statuses include: Approved, Denied, Pending, and Pre-Approved.
  - `approvalAmount` number, double — The dollar amount a customer has been approved for.
  - `isOkToDeliver` boolean — Indicates whether an Application is ready for delivery.
  - `merchantCustomerId` string, nullable — MerchantCustomerId provided by client.

## Other responses

- `400` — Invalid input
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Service Error

---

[API](https://skmtc.dev/progleasing/apis/progressive-leasing-commerce-api.md) · [All operations](https://skmtc.dev/progleasing/apis/progressive-leasing-commerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/progleasing/progressive-leasing-commerce-api/revisions/a51acdb02487/schema)