Respond to Line of Credit Offer

The Respond to Line of Credit Offer endpoint records the applicant's response to a line of credit offer. Use this endpoint when an applicant accepts or declines a soft pull offer generated as part of the credit application flow.

When an application passes initial checks, an offer is generated and delivered to the client via Thredd’s Event Delivery System (EDS). The client must then call this endpoint to record whether the applicant accepts or declines the offer.

• If the applicant accepts, a hard credit check is performed. If approved, a line of credit and payment card are created automatically.
• If the applicant declines, the application status is updated to OFFER_DECLINED and no further processing takes place.

Prerequisites

To integrate calls to the Respond to Line of Credit Offer endpoint, you need:

• A valid offer_id, delivered to the client via webhook when an offer is generated following a successful application submission.
• Your own user interface, such as a mobile app or web page, to present the offer to the applicant and capture their response.
• A subscription to Thredd webhooks so that you can receive the offer and subsequent application status updates, and communicate them to the applicant via your user interface.

Example Request

Record an applicant's response to a line of credit offer by making a POST request to the Respond to Line of Credit Offer endpoint, passing the offer ID as a path parameter.

POST {{baseUrl}}/api/v1/credit/applications/offers/{offer_id}/response

Path Parameters

Request Body

Example Payload

{
  "accepted": true
}

{
  "accepted": false
}

Example Response

A successful request returns a 200 HTTP code, confirming that the applicant's response has been recorded.

{
  "detail": [
    {
      "loc": ["body", "accepted"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

What Happens Next

After the applicant's response is recorded, the application status is updated and a webhook event is triggered. The application status will be one of the following, depending on the outcome: