federalInsuranceType
to savings offersfdic
forthe Federal Deposit Insurance Corporation, or ncua
for the NationalCredit Union Administration.partnerPageUrl
and embedUrl
to the RateTable
schemapartnerPageUrl
and embedUrl
to the RateTable
schema. This makes it easy for channel partners to POST lead data to the API (via the “Submit lead” endpoint), and present offer results either on a hosted partner page or in an embedded experience. Both options are optimized, compliant and white-labeled.partnerPageUrl
. To show offers results in an embed, add the following elements to the DOM:<script type="text/javascript" src="https://embed.hifiona.com/script/helper/bundle.js"></script>
<iframe scrolling="no" src="{{rateTable.embedUrl}}" style="width: 100%; border: none;" scrolling="no"></iframe>
{{rateTable.embedUrl}}
is replaced with the value of embedUrl
.partnerPageUrl
and embedUrl
will only be present on the RateTable
if an integration is properly configured in Control Center. If one is configured, the values will be returned on the initial call to the “Submit lead” endpoint, along with subsequent calls to “Get rate table” endpoint.eventData
to LeadEvent
schemaeventData
property to the LeadEvent
schema that is returned from the “Get lead events” endpoint. This property’s value is an object with a polymorphic schema which contains data specific to the event’s eventType
.eventData
property and it’s sub-properties are all optional. Availability of data will depend on the financial institution from which the events originated. Initially most data will be absent, but will be filled in as it becomes available.eventData
schemas replace the existing productType
and amountInCents
fields. Once the data available in eventData
reaches parity with these fields, they will be marked as deprecated and removed in the next major version.EventData
schema. As with the initial properties, data availability will depend on the source financial institution.