The Katapult API Supports a multistep process for building the application once you have the uid. To build the Katapult application for a consumer, the customer’s application data as shown in the Application JSON to the right should be sent in a PATCH request to Katapult with the new information.

Attributes

Attribute

Data Type

Description

Required Format

billing_address

string

customer's line 1 of billing address

none

billing_address2

string

customer's line 2 of billing address

none

billing_city

string

customer's billing city

none

billing_first_name

string

first name of the customer's billing information

none

billing_last_name

string

last name of the customer's billing information

none

billing_state

string

customer's billing state

2 char state abbrev.

billing_zip

string

customer's billing zip code

5 digit

dob_day

integer

customer's day of birth

1 or 2 digit number

dob_month

integer

customer's month of birth

1 or 2 digit number

dob_year

integer

customer's year of birth

4 digit number

email

string

customer's email address to receive lease agreement and notifications

none

income

string

customer's annual income

number

ssn

string

customer's social security number

9 digit number

privacy_agreement_accepted

string

indication if the privacy policy and terms and conditions were agreed to

true / false

Request Payload

{
  "billing_address" : "151 W 25th St",
    "billing_address2" : "9th Fl",
    "billing_city" : "New York",
    "billing_first_name" : "John",
    "billing_last_name" : "Doe",
    "billing_state" : "NY",
    "billing_zip" : "10010",
    "dob_day" : 11,
    "dob_month" : 6,
    "dob_year" : 1986,
    "email" :”[email protected]”,
  "income" : "50000.00",
  "ssn" : "431135234",
  "privacy_agreement_accepted": "true"
}

Build the Application Errors

Error

HTTP status

Description

UNAUTHORIZED

401

Invalid Authorization Token

Language
Authentication
Bearer
URL