Even Financial Lead API
A lead combines information about a user with search criteria for financial products, and is submitted in exchange for a rate table.A rate table is a list of financial offers that match a submitted lead.### Lead DetailsNo fields are required on a lead, but depending on the type of product requested, a minimum subset is required in order to potentially receive personalized offers. For details, see [the Financial Products overview](https://engine.tech/docs/api-reference/#financial-products).A lead may request multiple product types, in which case the returned rate table will include a list for each product type with matching offers.### Asynchronous Rate TablesOften a rate table will be built asynchronously. This means that although the rate table gets returned, the API may still be waiting for responses from one or more financial institutions. In these cases, you should poll the rate table until all responses are resolved before displaying the offers to the end user.So, if you submit a lead via the "Submit lead" endpoint and the returned rate table has a non-empty `pendingResponses` array, you should reload the rate table via the "Get rate table" endpoint, and continue to do so until `pendingResponses` is empty.
Even Financial Lead API is one of 6 APIs that Even Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Lead. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 5 operations across 4 paths, and defines 80 schemas. It is described by OpenAPI 3.0.3, at version 1.106.0.
Requests are made against a single base URL, https://api.engine.tech.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Even Financial Lead API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (publishableBearerToken).
It accepts HTTP bearer tokens (confidentialBearerToken).
It accepts HTTP bearer tokens (experimentalBearerToken).
publishableBearerToken— A bearer token that is assumed to be published in application code and downloaded to a user's device. As a result, it only has restricted access to the API.confidentialBearerToken— A bearer token that is assumed to be managed like a password or any other confidential secret. As a result, it has access to sensitive API endpoints.experimentalBearerToken— A bearer token that is used to access experimental endpoints that are not yet available for all partners. It may be treated the same as a publishableBearerToke…
Paths & Operations 5
Across 4 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
A lead combines information about a user with search criteria for financial products, and is submitted in exchange for a rate table. A rate table is a list of financial offers tha…
Schemas 80
The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are CreditCardOfferDetails (73 properties), LoanOffer (44 properties), LeadMortgageInformationJson (32 properties), Lead (31 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Even Financial 5
Other APIs Even Financial publishes across the network.