post https://www.katapult.com/api/v3/application/
To create the Katapult application for a consumer, the customer’s application data as shown in the Application JSON to the right should be sent either in a POST or PATCH request to Katapult.
Attributes
Attribute | Data Type | Description | Required Format |
---|---|---|---|
phone | string | customer's phone number | 10 digit number |
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 |
string | customer's email address to receive lease agreement and notifications | none | |
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_state | string | customer's billing state | none |
billing_zip | string | customer's billing zip code | none |
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 |
income | string | customer's annual income | number |
ssn | string | customer's social security number | 9 digit number |
last_pay_day | string | most recent date the customer was paid by his/her employer | YYYY-MM-DD |
next_pay_day | string | next anticipated date the customer will receive a paycheck from his/her employer | YYYY-MM-DD |
payment_frequency | string | how often the customer is paid by his/her employer | n/a |
privacy_agreement_accepted | string | indication if the privacy policy and terms and conditions were agreed to | true / false |
Request Payload
{
"phone": "1234567890",
"billing_first_name": "John",
"billing_last_name": "Doe",
"email": “jdoe @test.com”,
"billing_address": "14 28th Ave.",
"billing_address2": "",
"billing_city": "New York",
"billing_state": "NY",
"billing_zip": "11102",
"dob_day": 15,
"dob_month": 7,
"dob_year": 1984,
"income": "50000.00",
"ssn": "342134125",
"last_pay_date": "2020-10-14",
"next_pay_date: "2020-10-28",
"payment_frequency": "weekly" or "bi-weekly" or "semi-monthly" or "monthly",
"privacy_agreement_accepted": "true"
}
Create an Application Errors
Error | HTTP status | Description |
---|---|---|
BAD REQUEST | 400 | Invalid Request Payload / Missing Fields / Validation Error |
UNAUTHORIZED | 401 | Invalid Authorization Token |