Documentation index for AI agents (llms.txt)

Append .md to any page URL for its markdown source, or fetch llms-full.txt for the complete corpus.

Prequalification

List prequalification quotes generated for a partner.

GET/prequalification_data/

Authorizations

Authorizationstringheaderrequired

You must put the word Bearer or Token in the Authorization header before your token e.g:

Authorization: Bearer <Your API token>

Examples generated from this schema may be missing the word Bearer.

Query parameters

external_customer_idstring

The external_customer_id given by the partner in the csv file uploaded via POST /prequalification_data

prequalification_data_idstring

The prequalification_data_id (uploaded file name) sent to the partner in the response payload after a successful POST /prequalification_data

limitnumberrequired
offsetnumberrequired

Responses

Success

countnumber<integer>required

The total number of prequalification quotes for this partner based on the inclusion or exclusion of query parameters. (May be more than appear in the items list due to pagination).

Array of Prequalification Quotes
external_customer_idstringrequired

The customer id provided by the partner in the uploaded csv file.

is_prequalifiedbooleanrequired

Whether or not we were able to make a prequalification.

marketing_typestring

How the prequalification quote should be marketed to the customer.

prequalified_amountnumber<float>

The amount we think we could offer the customer.

quote_idstring<uuid>required