The Preapproval Lookup endpoint allows you to retrieve preapproval data for applications based on specified filters: date range, phone number, or email address.
HTTP Request
GET https://katapult.com/api/v3/application/preapproval_lookup/
Preapproval Filter Parameters
| Query Parameters | Description | Data Type |
|---|---|---|
| date_filter | Specifies the type of date to filter by. For this endpoint, use preapproved_date | string |
| start | The start date for the date range filter in YYYY-MM-DD format. Required if using date filtering | string |
| end | The end date for the date range filter in YYYY-MM-DD format. Required if using date filtering | string |
| phone | The phone number to filter by | string |
| The email address to filter by | string |
If there is no filter applied then API will return list of all the active preapprovals
Headers
| Query Parameters | Description | Data Type |
|---|---|---|
| Authorization | Bearer token for authentication. Replace Bearer <katapult-retailer-private-token> with your actual private API token | string |
| Accept | Specifies the format of the response. Use application/json to receive a JSON formatted response. | string |
Sample cURL Requests
Using Date Filter
curl --location 'https://katapult.com/api/v3/application/preapproval_lookup/?date_filter=preapproved_date&start=2024-05-01&end=2024-06-09' \
--header 'Authorization: Bearer <private-token>' \
--header 'Accept: application/json
Using Phone Filter
curl --location 'https://katapult.com/api/v3/application/preapproval_lookup/?phone=1234567890' \
--header 'Authorization: Bearer <private-token>' \
--header 'Accept: application/json'
Using Email Filter
curl --location 'https://katapult.com/api/v3/application/preapproval_lookup/[email protected]' \
--header 'Authorization: Bearer <private-token>' \
--header 'Accept: application/json'
Response Codes
| Attribute | Description |
|---|---|
| 202 Accepted | The request was successful, and the response contains the preapproval data |
| 400 Bad Request | The request could not be understood or was missing the required parameters |
| 401 Unauthorized | Authentication failed or user does not have permissions for the requested operation |