@moneylion/react-native-offer-carousel 1.8.0 → 1.8.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (279) hide show
  1. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.js.map +1 -1
  2. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.js.map +1 -1
  3. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/index.js.map +1 -1
  4. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.js.map +1 -1
  5. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/percentage.js.map +1 -1
  6. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrency.js.map +1 -1
  7. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.js.map +1 -1
  8. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.js.map +1 -1
  9. package/lib/commonjs/capabilities/ui/elements/src/components/MarkdownText/Abbreviation.js +1 -2
  10. package/lib/commonjs/capabilities/ui/elements/src/components/MarkdownText/Abbreviation.js.map +1 -1
  11. package/lib/commonjs/components/Button/index.js +1 -2
  12. package/lib/commonjs/components/Button/index.js.map +1 -1
  13. package/lib/commonjs/components/Common/DynamicOfferCard/SeeMore.js +1 -2
  14. package/lib/commonjs/components/Common/DynamicOfferCard/SeeMore.js.map +1 -1
  15. package/lib/commonjs/components/DynamicOffers/DynamicOffersContainer.js +1 -2
  16. package/lib/commonjs/components/DynamicOffers/DynamicOffersContainer.js.map +1 -1
  17. package/lib/commonjs/components/DynamicOffers/Render/DynamicOffersRender.js +1 -2
  18. package/lib/commonjs/components/DynamicOffers/Render/DynamicOffersRender.js.map +1 -1
  19. package/lib/commonjs/components/DynamicOffers/Render/Offer.js +1 -2
  20. package/lib/commonjs/components/DynamicOffers/Render/Offer.js.map +1 -1
  21. package/lib/commonjs/components/Modal/AllOffersModal.js +1 -2
  22. package/lib/commonjs/components/Modal/AllOffersModal.js.map +1 -1
  23. package/lib/commonjs/components/MoneyLionOfferCarousel.js +24 -4
  24. package/lib/commonjs/components/MoneyLionOfferCarousel.js.map +1 -1
  25. package/lib/commonjs/components/Skeleton/Skeleton.js +1 -2
  26. package/lib/commonjs/components/Skeleton/Skeleton.js.map +1 -1
  27. package/lib/commonjs/components/Touchable/index.js +1 -2
  28. package/lib/commonjs/components/Touchable/index.js.map +1 -1
  29. package/lib/commonjs/components/utils/errorUtils.js +18 -23
  30. package/lib/commonjs/components/utils/errorUtils.js.map +1 -1
  31. package/lib/commonjs/context/ConfigurationProvider.js +1 -2
  32. package/lib/commonjs/context/ConfigurationProvider.js.map +1 -1
  33. package/lib/commonjs/context/EventHandlerProvider.js +1 -2
  34. package/lib/commonjs/context/EventHandlerProvider.js.map +1 -1
  35. package/lib/commonjs/context/ThemeProvider.js +1 -2
  36. package/lib/commonjs/context/ThemeProvider.js.map +1 -1
  37. package/lib/commonjs/version.js +2 -3
  38. package/lib/commonjs/version.js.map +1 -1
  39. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.js.map +1 -1
  40. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.js.map +1 -1
  41. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/index.js +18 -19
  42. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/index.js.map +1 -1
  43. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.js.map +1 -1
  44. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/percentage.js.map +1 -1
  45. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrency.js.map +1 -1
  46. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.js.map +1 -1
  47. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.js.map +1 -1
  48. package/lib/module/components/MoneyLionOfferCarousel.js +24 -3
  49. package/lib/module/components/MoneyLionOfferCarousel.js.map +1 -1
  50. package/lib/module/components/utils/errorUtils.js +18 -23
  51. package/lib/module/components/utils/errorUtils.js.map +1 -1
  52. package/lib/module/version.js +2 -2
  53. package/lib/module/version.js.map +1 -1
  54. package/lib/typescript/src/apiEnvironment.d.ts.map +1 -1
  55. package/lib/typescript/src/capabilities/configuration/src/brands/checkVisualEligibility.d.ts.map +1 -1
  56. package/lib/typescript/src/capabilities/configuration/src/brands/createDerivedBrands.d.ts.map +1 -1
  57. package/lib/typescript/src/capabilities/configuration/src/brands/types.d.ts.map +1 -1
  58. package/lib/typescript/src/capabilities/configuration/src/userData/types.d.ts +6 -0
  59. package/lib/typescript/src/capabilities/configuration/src/userData/types.d.ts.map +1 -1
  60. package/lib/typescript/src/capabilities/core/src/domain/third-party-search/orderProductTypesByRankUtils.d.ts.map +1 -1
  61. package/lib/typescript/src/capabilities/errors/types/index.d.ts.map +1 -1
  62. package/lib/typescript/src/capabilities/offer-catalog/src/api/offerCatalogApi.d.ts +2 -2
  63. package/lib/typescript/src/capabilities/offer-catalog/src/api/offerCatalogApi.d.ts.map +1 -1
  64. package/lib/typescript/src/capabilities/offer-catalog/src/utils/arrayToMarkdownList.d.ts.map +1 -1
  65. package/lib/typescript/src/capabilities/offer-catalog/src/utils/contextUtil.d.ts.map +1 -1
  66. package/lib/typescript/src/capabilities/offer-catalog/src/utils/formatUtils.d.ts.map +1 -1
  67. package/lib/typescript/src/capabilities/offer-catalog/src/utils/getEventCallbackContext.d.ts.map +1 -1
  68. package/lib/typescript/src/capabilities/offer-catalog/src/utils/getOfferUrl.d.ts.map +1 -1
  69. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/annualFee.d.ts.map +1 -1
  70. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/boolean.d.ts.map +1 -1
  71. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/common.d.ts.map +1 -1
  72. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/creditBureaus.d.ts.map +1 -1
  73. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/currency.d.ts.map +1 -1
  74. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.d.ts.map +1 -1
  75. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/freeTrialDays.d.ts.map +1 -1
  76. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.d.ts.map +1 -1
  77. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/index.d.ts +18 -19
  78. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/index.d.ts.map +1 -1
  79. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.d.ts.map +1 -1
  80. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/percentage.d.ts.map +1 -1
  81. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/purchaseApr.d.ts.map +1 -1
  82. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrency.d.ts.map +1 -1
  83. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyByTime.d.ts.map +1 -1
  84. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyUnabbreviated.d.ts.map +1 -1
  85. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeMonths.d.ts.map +1 -1
  86. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.d.ts.map +1 -1
  87. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.d.ts.map +1 -1
  88. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rewardsDisplay.d.ts.map +1 -1
  89. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/index.d.ts.map +1 -1
  90. package/lib/typescript/src/capabilities/offers/pipeline/src/sources/ratetables/offer-catalog/types/oas/offer-catalog.d.ts.map +1 -1
  91. package/lib/typescript/src/capabilities/offers/pipeline/src/sources/ratetables/withDeviceSignals.d.ts +11 -11
  92. package/lib/typescript/src/capabilities/offers/pipeline/src/sources/ratetables/withDeviceSignals.d.ts.map +1 -1
  93. package/lib/typescript/src/capabilities/ui/elements/src/components/MarkdownText/Abbreviation.d.ts +2 -2
  94. package/lib/typescript/src/capabilities/ui/elements/src/components/MarkdownText/Abbreviation.d.ts.map +1 -1
  95. package/lib/typescript/src/capabilities/ui/elements/src/components/MarkdownText/components.d.ts +4 -4
  96. package/lib/typescript/src/capabilities/ui/elements/src/components/MarkdownText/components.d.ts.map +1 -1
  97. package/lib/typescript/src/capabilities/ui/elements/src/components/MarkdownText/index.d.ts.map +1 -1
  98. package/lib/typescript/src/capabilities/ui/elements/src/components/MarkdownText/markdownPreprocessor.d.ts.map +1 -1
  99. package/lib/typescript/src/capabilities/ui/elements/src/components/thumbor/index.d.ts.map +1 -1
  100. package/lib/typescript/src/capabilities/ui/elements/src/offerCardAttributes.d.ts +1 -2
  101. package/lib/typescript/src/capabilities/ui/elements/src/offerCardAttributes.d.ts.map +1 -1
  102. package/lib/typescript/src/components/Common/BaseOfferCard/Stat/Stat.d.ts +3 -3
  103. package/lib/typescript/src/components/Common/BaseOfferCard/Stat/Stat.d.ts.map +1 -1
  104. package/lib/typescript/src/components/Common/BaseOfferCard/Stat/index.d.ts.map +1 -1
  105. package/lib/typescript/src/components/Common/BaseOfferCard/StatsContainer/StatsContainer.d.ts.map +1 -1
  106. package/lib/typescript/src/components/Common/BaseOfferCard/index.d.ts +7 -7
  107. package/lib/typescript/src/components/Common/BaseOfferCard/index.d.ts.map +1 -1
  108. package/lib/typescript/src/components/Common/DynamicOfferCard/CallToAction.d.ts.map +1 -1
  109. package/lib/typescript/src/components/Common/DynamicOfferCard/SeeMore.d.ts.map +1 -1
  110. package/lib/typescript/src/components/Divider/index.d.ts.map +1 -1
  111. package/lib/typescript/src/components/DynamicOffers/DynamicOffers.d.ts.map +1 -1
  112. package/lib/typescript/src/components/DynamicOffers/DynamicOffersContainer.d.ts.map +1 -1
  113. package/lib/typescript/src/components/DynamicOffers/Render/DynamicOffersRender.d.ts.map +1 -1
  114. package/lib/typescript/src/components/DynamicOffers/Render/Offer.d.ts.map +1 -1
  115. package/lib/typescript/src/components/DynamicOffers/SeeAllButton.d.ts.map +1 -1
  116. package/lib/typescript/src/components/Layouts/CreditCardOfferCard/index.d.ts.map +1 -1
  117. package/lib/typescript/src/components/Layouts/CreditCardOfferCard/statsBuilder.d.ts.map +1 -1
  118. package/lib/typescript/src/components/Layouts/DefaultOfferCard/index.d.ts.map +1 -1
  119. package/lib/typescript/src/components/Layouts/DefaultOfferCard/statsBuilder.d.ts.map +1 -1
  120. package/lib/typescript/src/components/Layouts/HeadlineWithDescriptionCard/index.d.ts.map +1 -1
  121. package/lib/typescript/src/components/Modal/AllOffersModal.d.ts.map +1 -1
  122. package/lib/typescript/src/components/Modal/OfferDetailsModal.d.ts.map +1 -1
  123. package/lib/typescript/src/components/MoneyLionOfferCarousel.d.ts.map +1 -1
  124. package/lib/typescript/src/components/Skeleton/Skeleton.d.ts.map +1 -1
  125. package/lib/typescript/src/components/Touchable/TouchableOpacity.d.ts +0 -1
  126. package/lib/typescript/src/components/Touchable/TouchableOpacity.d.ts.map +1 -1
  127. package/lib/typescript/src/components/utils/errorUtils.d.ts +3 -3
  128. package/lib/typescript/src/components/utils/errorUtils.d.ts.map +1 -1
  129. package/lib/typescript/src/context/ConfigurationProvider.d.ts.map +1 -1
  130. package/lib/typescript/src/index.d.ts +1 -0
  131. package/lib/typescript/src/index.d.ts.map +1 -1
  132. package/lib/typescript/src/services/getDynamicOffers.d.ts.map +1 -1
  133. package/lib/typescript/src/services/getProductTypes.d.ts.map +1 -1
  134. package/lib/typescript/src/services/getProductTypesByQuery.d.ts.map +1 -1
  135. package/lib/typescript/src/utils/addClientTagsToOfferLinks.d.ts.map +1 -1
  136. package/lib/typescript/src/utils/formatOfferUrl.d.ts +39 -44
  137. package/lib/typescript/src/utils/formatOfferUrl.d.ts.map +1 -1
  138. package/lib/typescript/src/utils/getDefaultProductType.d.ts.map +1 -1
  139. package/lib/typescript/src/utils/getEnableUseCachedOffers.d.ts.map +1 -1
  140. package/lib/typescript/src/utils/getOffersByProductTypes.d.ts +3 -3
  141. package/lib/typescript/src/utils/getOffersByProductTypes.d.ts.map +1 -1
  142. package/lib/typescript/src/utils/getProductTypesDefinition.d.ts.map +1 -1
  143. package/lib/typescript/src/utils/getThemeColors.d.ts.map +1 -1
  144. package/lib/typescript/src/utils/parseStringProductTypes.d.ts.map +1 -1
  145. package/lib/typescript/src/utils/resolveProductTypes.d.ts.map +1 -1
  146. package/lib/typescript/src/utils/selectDynamicOffers.d.ts.map +1 -1
  147. package/lib/typescript/src/utils/sortOffersByRecommendationScore.d.ts.map +1 -1
  148. package/lib/typescript/src/version.d.ts +1 -1
  149. package/lib/typescript/src/version.d.ts.map +1 -1
  150. package/package.json +81 -135
  151. package/src/capabilities/configuration/src/userData/types.ts +6 -0
  152. package/src/capabilities/errors/types/index.ts +4 -2
  153. package/src/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.ts +0 -1
  154. package/src/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.ts +0 -1
  155. package/src/capabilities/offer-catalog/src/utils/stats/formatters/index.ts +18 -19
  156. package/src/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.ts +0 -1
  157. package/src/capabilities/offer-catalog/src/utils/stats/formatters/percentage.ts +0 -1
  158. package/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrency.ts +0 -1
  159. package/src/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.ts +0 -1
  160. package/src/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.ts +0 -1
  161. package/src/capabilities/offers/pipeline/src/sources/ratetables/offer-catalog/types/oas/offer-catalog.ts +1 -1
  162. package/src/capabilities/offers/pipeline/src/sources/ratetables/types/PublicApi.d.ts +1939 -1921
  163. package/src/components/Common/BaseOfferCard/Stat/index.tsx +1 -1
  164. package/src/components/MoneyLionOfferCarousel.tsx +42 -3
  165. package/src/components/utils/errorUtils.ts +17 -23
  166. package/src/index.tsx +4 -0
  167. package/src/version.ts +2 -2
  168. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/boolean.spec.js +0 -60
  169. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/boolean.spec.js.map +0 -1
  170. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/common.spec.js +0 -62
  171. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/common.spec.js.map +0 -1
  172. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/creditBureaus.spec.js +0 -31
  173. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/creditBureaus.spec.js.map +0 -1
  174. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.spec.js +0 -208
  175. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.spec.js.map +0 -1
  176. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/freeTrialDays.spec.js +0 -24
  177. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/freeTrialDays.spec.js.map +0 -1
  178. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.spec.js +0 -40
  179. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.spec.js.map +0 -1
  180. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.spec.js +0 -43
  181. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.spec.js.map +0 -1
  182. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/percentage.spec.js +0 -32
  183. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/percentage.spec.js.map +0 -1
  184. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/purchaseApr.spec.js +0 -69
  185. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/purchaseApr.spec.js.map +0 -1
  186. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyByTime.spec.js +0 -72
  187. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyByTime.spec.js.map +0 -1
  188. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyUnabbreviated.spec.js +0 -29
  189. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyUnabbreviated.spec.js.map +0 -1
  190. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangeMonths.spec.js +0 -46
  191. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangeMonths.spec.js.map +0 -1
  192. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.spec.js +0 -83
  193. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.spec.js.map +0 -1
  194. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.spec.js +0 -28
  195. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.spec.js.map +0 -1
  196. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rewardsDisplay.spec.js +0 -30
  197. package/lib/commonjs/capabilities/offer-catalog/src/utils/stats/formatters/rewardsDisplay.spec.js.map +0 -1
  198. package/lib/commonjs/capabilities/ui/elements/src/components/thumbor/useSvgUriViewBox.test.js +0 -44
  199. package/lib/commonjs/capabilities/ui/elements/src/components/thumbor/useSvgUriViewBox.test.js.map +0 -1
  200. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/boolean.spec.js +0 -59
  201. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/boolean.spec.js.map +0 -1
  202. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/common.spec.js +0 -61
  203. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/common.spec.js.map +0 -1
  204. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/creditBureaus.spec.js +0 -30
  205. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/creditBureaus.spec.js.map +0 -1
  206. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.spec.js +0 -207
  207. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.spec.js.map +0 -1
  208. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/freeTrialDays.spec.js +0 -23
  209. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/freeTrialDays.spec.js.map +0 -1
  210. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.spec.js +0 -39
  211. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.spec.js.map +0 -1
  212. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.spec.js +0 -42
  213. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.spec.js.map +0 -1
  214. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/percentage.spec.js +0 -31
  215. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/percentage.spec.js.map +0 -1
  216. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/purchaseApr.spec.js +0 -68
  217. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/purchaseApr.spec.js.map +0 -1
  218. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyByTime.spec.js +0 -71
  219. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyByTime.spec.js.map +0 -1
  220. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyUnabbreviated.spec.js +0 -28
  221. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyUnabbreviated.spec.js.map +0 -1
  222. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangeMonths.spec.js +0 -45
  223. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangeMonths.spec.js.map +0 -1
  224. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.spec.js +0 -82
  225. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.spec.js.map +0 -1
  226. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.spec.js +0 -27
  227. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.spec.js.map +0 -1
  228. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rewardsDisplay.spec.js +0 -29
  229. package/lib/module/capabilities/offer-catalog/src/utils/stats/formatters/rewardsDisplay.spec.js.map +0 -1
  230. package/lib/module/capabilities/ui/elements/src/components/thumbor/useSvgUriViewBox.test.js +0 -43
  231. package/lib/module/capabilities/ui/elements/src/components/thumbor/useSvgUriViewBox.test.js.map +0 -1
  232. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/boolean.spec.d.ts +0 -1
  233. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/boolean.spec.d.ts.map +0 -1
  234. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/common.spec.d.ts +0 -1
  235. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/common.spec.d.ts.map +0 -1
  236. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/creditBureaus.spec.d.ts +0 -1
  237. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/creditBureaus.spec.d.ts.map +0 -1
  238. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.spec.d.ts +0 -1
  239. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.spec.d.ts.map +0 -1
  240. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/freeTrialDays.spec.d.ts +0 -1
  241. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/freeTrialDays.spec.d.ts.map +0 -1
  242. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.spec.d.ts +0 -1
  243. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.spec.d.ts.map +0 -1
  244. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.spec.d.ts +0 -1
  245. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.spec.d.ts.map +0 -1
  246. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/percentage.spec.d.ts +0 -1
  247. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/percentage.spec.d.ts.map +0 -1
  248. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/purchaseApr.spec.d.ts +0 -1
  249. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/purchaseApr.spec.d.ts.map +0 -1
  250. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyByTime.spec.d.ts +0 -1
  251. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyByTime.spec.d.ts.map +0 -1
  252. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyUnabbreviated.spec.d.ts +0 -1
  253. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyUnabbreviated.spec.d.ts.map +0 -1
  254. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeMonths.spec.d.ts +0 -1
  255. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeMonths.spec.d.ts.map +0 -1
  256. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.spec.d.ts +0 -1
  257. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.spec.d.ts.map +0 -1
  258. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.spec.d.ts +0 -1
  259. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.spec.d.ts.map +0 -1
  260. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rewardsDisplay.spec.d.ts +0 -1
  261. package/lib/typescript/src/capabilities/offer-catalog/src/utils/stats/formatters/rewardsDisplay.spec.d.ts.map +0 -1
  262. package/lib/typescript/src/capabilities/ui/elements/src/components/thumbor/useSvgUriViewBox.test.d.ts +0 -1
  263. package/lib/typescript/src/capabilities/ui/elements/src/components/thumbor/useSvgUriViewBox.test.d.ts.map +0 -1
  264. package/src/capabilities/offer-catalog/src/utils/stats/formatters/boolean.spec.ts +0 -58
  265. package/src/capabilities/offer-catalog/src/utils/stats/formatters/common.spec.ts +0 -60
  266. package/src/capabilities/offer-catalog/src/utils/stats/formatters/creditBureaus.spec.ts +0 -29
  267. package/src/capabilities/offer-catalog/src/utils/stats/formatters/currencyOrBasis.spec.ts +0 -206
  268. package/src/capabilities/offer-catalog/src/utils/stats/formatters/freeTrialDays.spec.ts +0 -22
  269. package/src/capabilities/offer-catalog/src/utils/stats/formatters/fromListStringWithAnd.spec.ts +0 -38
  270. package/src/capabilities/offer-catalog/src/utils/stats/formatters/monthlyOrAnnualCurrency.spec.ts +0 -41
  271. package/src/capabilities/offer-catalog/src/utils/stats/formatters/percentage.spec.ts +0 -30
  272. package/src/capabilities/offer-catalog/src/utils/stats/formatters/purchaseApr.spec.ts +0 -67
  273. package/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyByTime.spec.ts +0 -70
  274. package/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeCurrencyUnabbreviated.spec.ts +0 -27
  275. package/src/capabilities/offer-catalog/src/utils/stats/formatters/rangeMonths.spec.ts +0 -44
  276. package/src/capabilities/offer-catalog/src/utils/stats/formatters/rangePercent.spec.ts +0 -81
  277. package/src/capabilities/offer-catalog/src/utils/stats/formatters/recommendedCredit.spec.ts +0 -26
  278. package/src/capabilities/offer-catalog/src/utils/stats/formatters/rewardsDisplay.spec.ts +0 -28
  279. package/src/capabilities/ui/elements/src/components/thumbor/useSvgUriViewBox.test.ts +0 -42
@@ -1,1924 +1,1942 @@
1
1
  export interface components {
2
2
  schemas: {
3
- ApiError: {
4
- /** @description The attribute that this error applies to. Omitted if this error is not in the context of a resource, or cannot be isolated to a single attribute. */
5
- attribute?: string
6
- /** @description A classification for this error, which can be used to render the appropriate custom error template, or take other programmatic actions. */
7
- type?: string
8
- /** @description Variables associated with this error that can be injected into a custom error template, or used to parameterize any other programatic actions. */
9
- details?: components['schemas']['ApiErrorDetails']
10
- /** @description A human-readable, English description of the error. */
11
- message?: string
12
- }
13
- ApiErrorDetails: {
14
- [key: string]: string
15
- }
16
- /** apiApproved */
17
- ApiApprovedEventData: {
18
- /** @description The product type of the approved offer. */
19
- productType?: components['schemas']['ProductType']
20
- }
21
- /** apiRejected */
22
- ApiRejectedEventData: {
23
- /** @description A normalized reason why the lead was rejected, according to the financial institution. */
24
- rejectReason?: components['schemas']['RejectReason']
25
- /** @description The product type of the rejected offer. */
26
- productType?: components['schemas']['ProductType']
27
- }
28
- /** applied */
29
- AppliedEventData: {
30
- /**
31
- * Format: int32
32
- * @description The dollar amount of the offer that was applied for.
33
- */
34
- amount?: number
35
- /** @description The product type of the offer that was applied for. */
36
- productType?: components['schemas']['ProductType']
37
- }
38
- /** approved */
39
- ApprovedEventData: {
40
- /**
41
- * Format: int32
42
- * @description The dollar amount of the approved offer.
43
- */
44
- amount?: number
45
- /** @description The product type of the approved offer. */
46
- productType?: components['schemas']['ProductType']
47
- }
48
- /** @enum {string} */
49
- AprType: 'variable' | 'regular' | 'fixed'
50
- /** @enum {string} */
51
- BankAccountType: 'checking' | 'savings' | 'other'
52
- /**
53
- * @description Benefits or benefit categories related to a credit card
54
- * @enum {string}
55
- */
56
- CardBenefit:
57
- | 'No Foreign Transaction Fees'
58
- | 'Purchase Protection'
59
- | 'Return Protection'
60
- | 'Price Protection'
61
- | 'Fraud Protection'
62
- | 'Extended Warranty'
63
- | 'Travel Accident Insurance'
64
- | 'Trip Interruption Insurance'
65
- | 'Car Rental Insurance'
66
- | 'Baggage Insurance'
67
- | 'Baggage Delay Insurance'
68
- | 'Hotel Burglary Insurance'
69
- | 'Travel & Emergency Assistance'
70
- | 'Roadside Assistance'
71
- | 'Concierge Service'
72
- | 'Lounge Access'
73
- | 'Identity Theft Assistance'
74
- | 'In-Flight Savings'
75
- | 'Free Checked Bag'
76
- | 'Priority Boarding'
77
- | 'No Blackout Dates'
78
- | 'Free Companion Ticket'
79
- | 'Discount Companion Ticket'
80
- | 'Global Entry or TSA PreCheck'
81
- | 'Private Jet Perks'
82
- | 'Lounge Access Discount'
83
- | '24/7 Cardholder Support'
84
- | 'Authorized User'
85
- | 'Entertainment Access'
86
- | 'Airline Fee Credit'
87
- | 'Late Fee Pass'
88
- | 'Credit Score Reporting'
89
- | 'No Flight Change Fees'
90
- | '24/7 Account Monitoring'
91
- | 'Amex Offers'
92
- | 'Visa Signature Offers'
93
- | 'MasterCard Offers'
94
- | 'Free Hotel Stay'
95
- | 'Extended Hotel Stay'
96
- | 'Dining Concierge'
97
- | '2 Lounge Passes'
98
- | 'Hilton Honors Silver Membership'
99
- | 'Hilton Honors Gold Membership'
100
- | 'World of Hyatt Discoverist Status'
101
- | 'SPG Gold Membership'
102
- | 'Marriott Rewards Silver Status'
103
- | 'Hertz Presidents Circle Elite Status'
104
- | '2 Free Checked Bags'
105
- | 'Auto Discounts'
106
- | 'InCircle Partnership'
107
- | 'ShopRunner'
108
- | 'WiFi Access'
109
- | 'ShopSafe'
110
- | 'BoA Preferred Rewards'
111
- | 'MasterCard Fuel Rewards Network'
112
- | 'Missed Event Ticket Protection'
113
- | 'Account Freezing'
114
- | 'Cell Phone Protection'
115
- | 'GPA Rewards'
116
- | 'In-Flight WiFi Credit'
117
- | 'Citi Private Pass'
118
- | 'Priceless Cities'
119
- | 'The Hotel Collection'
120
- | 'By Invitation Only'
121
- | 'Luxury Hotel Collection'
122
- | 'Expedia+ Silver Status'
123
- | 'Expedia+ Gold Status'
124
- | '$100 American Airlines Discount'
125
- | 'Disney Parks Perks and Savings'
126
- | 'Ritz-Carlton Gold Elite Status'
127
- | 'Ritz-Carlton Club Level Upgrade'
128
- | 'Annual Travel Credit'
129
- | 'IHG Platinum Elite Status'
130
- | 'QuickBooks Connect'
131
- | 'ReceiptMatch'
132
- | 'Employee Spending Limits'
133
- | 'FX International Payments'
134
- | 'No Pre-Set Spending Limit'
135
- | 'Purchase Financing'
136
- | 'Amex Open Savings'
137
- | 'Amazon Special Financing'
138
- | '$100 Ritz-Carlton Hotel Credit'
139
- | 'British Airways Companion Ticket'
140
- | 'Mercedes-Benz Gift Certificates'
141
- | 'Mercedes-Benz Excess Mileage Waiver'
142
- | 'JetBlue Annual Statement Credit'
143
- | '20% Discount on Delta Flights for Delta Private Jet Members'
144
- | 'Expense Report Features'
145
- | 'Business Cell Phone Protection'
146
- | 'Free Shipping on most Target.com orders'
147
- | '30 Extra Days for Returns'
148
- | 'Free clothing altertaions'
149
- | 'Personal shopping'
150
- | 'Shopmyway Savings'
151
- | 'Online Subscription Credit'
152
- | 'Uber Exclusive Access'
153
- | 'Airline Benefits'
154
- | 'Hotel Benefits'
155
- | 'Other Travel Benefits'
156
- | 'Emergency Assistance'
157
- | 'Experiences'
158
- | 'Shopping Benefits'
159
- | 'Cardholder Benefits'
160
- | 'Enhanced Security'
161
- | 'Business Benefits'
162
- | 'Other Benefits'
163
- | 'In-Flight Discounts'
164
- | 'Fee Coverage'
165
- | 'Flight Credits & Discounts'
166
- | 'Hotel Membership Status'
167
- | 'Hotel Credit & Free Stays'
168
- | 'Travel Credit'
169
- | 'Travel Experiences Programs'
170
- | 'Car Rental Membership Status'
171
- | 'Extra Gas Rewards'
172
- | 'Shopping Protection'
173
- | 'Shopping Discounts'
174
- | 'Free Shipping'
175
- | 'The Boingo American Express Preferred Plan'
176
- | 'AirSpace Lounge'
177
- | 'Uber Monthly Credit'
178
- | 'Ride Share Benefits'
179
- | 'Delta Sky Club'
180
- | 'Admirals Club Membership'
181
- | 'Priority Pass Select Membership (Prestige)'
182
- | 'Priority Pass Select Membership (Standard Plus)'
183
- | 'Daily Breakfast'
184
- | 'Early Check-in & Late Check-out'
185
- | 'Room Upgrades'
186
- | 'Complementary WiFi'
187
- | 'Amex Hotel Collection Credit'
188
- | 'Temporary Account Numbers'
189
- | 'One-Time 50% Discount on Companion Ticket'
190
- | 'Airline Travel Credit'
191
- | 'United Club Membership'
192
- | 'Chip Technology'
193
- | 'Earn More Miles for Sharing Travel Stories'
194
- | 'Mastercard World Elite Concierge and Luxury Travel Benefits'
195
- | '20% Savings on Delta In-Flight Purchases'
196
- | '25% Savings on United In-Flight Food and Drink Purchases'
197
- | '$100 Hilton Properties Credit'
198
- | '$250 Hilton Resort Credit'
199
- | 'Hilton Honors Diamond Membership'
200
- | 'Free Birthday Gift'
201
- | '2x Points During Your Birthday Month'
202
- | 'Car Rental VIP Perks'
203
- | 'Free shipping with the purchase of a bra'
204
- | 'Monthly Dining Credit'
205
- | 'Amazon Prime Student'
206
- /**
207
- * @description Purposes or categories related to a credit card
208
- * @enum {string}
209
- */
210
- CardPurpose:
211
- | 'balance_transfer'
212
- | 'cash_back'
213
- | 'earning_rewards'
214
- | 'improve_credit'
215
- | 'low_interest'
216
- | 'new_to_credit'
217
- | 'student'
218
- | 'travel_incentives'
219
- /** @enum {string} */
220
- CardType: 'visa' | 'mastercard' | 'american_express' | 'discover'
221
- /**
222
- * @description Carrier decision speed
223
- * @enum {string}
224
- */
225
- CarrierDecisionType: 'instant' | 'non_instant'
226
- /**
227
- * @description Citizenship status
228
- * @enum {string}
229
- */
230
- CitizenshipStatus: 'citizen' | 'permanent_resident' | 'other'
231
- /** @enum {string} */
232
- CompoundingMethod:
233
- | 'annually'
234
- | 'continuous'
235
- | 'daily'
236
- | 'monthly'
237
- | 'quarterly'
238
- | 'semiAnnually'
239
- | 'simple'
240
- | 'weekly'
241
- /** @description An offer for a credit card */
242
- CreditCardOffer: WithRequired<
243
- {
244
- details: components['schemas']['CreditCardOfferDetails']
245
- } & components['schemas']['Offer'],
246
- 'details'
247
- >
248
- CreditCardOfferDetails: {
249
- /** @description Display name of the card */
250
- cardName?: string
251
- /** Format: url */
252
- cardImageUrl: string
253
- cardPurposes?: components['schemas']['CardPurpose'][]
254
- /**
255
- * Format: url
256
- * @description External link to card rates, terms and conditions
257
- */
258
- ratesUrl?: string
259
- maxPurchaseApr?: number
260
- minPurchaseApr?: number
261
- purchaseAprText?: string
262
- maxPurchaseIntroApr?: number
263
- minPurchaseIntroApr?: number
264
- /** Format: int32 */
265
- purchaseIntroAprTerm?: number
266
- purchaseIntroAprTermUnit?: components['schemas']['TermUnit']
267
- purchaseIntroAprText?: string
268
- maxCashAdvanceApr?: number
269
- minCashAdvanceApr?: number
270
- cashAdvanceAprText?: string
271
- maxCashAdvanceIntroApr?: number
272
- minCashAdvanceIntroApr?: number
273
- /** Format: int32 */
274
- cashAdvanceIntroAprTerm?: number
275
- cashAdvanceIntroAprTermUnit?: components['schemas']['TermUnit']
276
- cashAdvanceIntroAprText?: string
277
- maxBalanceTransferApr?: number
278
- minBalanceTransferApr?: number
279
- balanceTransferAprText?: string
280
- maxBalanceTransferIntroApr?: number
281
- minBalanceTransferIntroApr?: number
282
- /** Format: int32 */
283
- balanceTransferIntroAprTerm?: number
284
- balanceTransferIntroAprTermUnit?: components['schemas']['TermUnit']
285
- balanceTransferIntroAprText?: string
286
- maxAnnualFee?: number
287
- minAnnualFee?: number
288
- annualIntroFee?: number
289
- /**
290
- * Format: int32
291
- * @description Number of _years_ the introductory anual fee is in effect
292
- */
293
- annualIntroFeeTerm?: number
294
- introOfferAmount?: number
295
- introOfferText?: string
296
- introOfferType?: components['schemas']['IntroOfferType']
297
- /** @description List of card features which must be prominently displayed with the offer */
298
- details?: string[]
299
- /** @description List of card features which must be displayed with the offer */
300
- additionalDetails?: string[]
301
- cardType: components['schemas']['CardType']
302
- minimumCreditLine?: number
303
- minimumPenaltyApr?: number
304
- maximumPenaltyApr?: number
305
- balanceTransferFee?: number
306
- cashAdvanceFee?: number
307
- lateFee?: number
308
- foreignExchangeFee?: number
309
- accountOpeningFee?: number
310
- returnPaymentFee?: number
311
- monthlyServiceFee?: number
312
- recommendedCreditRatings?: components['schemas']['ProvidedCreditRating'][]
313
- preQualified: boolean
314
- preApproved: boolean
315
- /** @description Indicates that Engine by MoneyLion has determined that the user has an increased likelihood of being approved for this card. */
316
- preSelected: boolean
317
- /**
318
- * Format: double
319
- * @description Percentage represented in decimal format added to all foreign transactions
320
- */
321
- foreignTransactionFee?: number
322
- cardBenefits?: components['schemas']['CardBenefit'][]
323
- }
324
- /**
325
- * @description Arbitrary key-values mappings to associate with a `Lead`. This field can be use to attach `subid`s to a `Lead`
326
- * @example {
327
- * "subid": [
328
- * "123"
329
- * ]
330
- * }
331
- */
332
- ClientTags: {
333
- [key: string]: string[]
334
- }
335
- /** conversion */
336
- ConversionEventData: {
337
- /**
338
- * Format: int32
339
- * @description The number of cents paid out for the conversion event.
340
- */
341
- payoutInCents?: number
342
- /** @description The product type of the converted offer. */
343
- productType?: components['schemas']['ProductType']
344
- }
345
- /** @enum {string} */
346
- EducationLevel:
347
- | 'high_school'
348
- | 'associate'
349
- | 'bachelors'
350
- | 'masters'
351
- | 'doctorate'
352
- | 'other_grad_degree'
353
- | 'certificate'
354
- | 'did_not_graduate'
355
- | 'still_enrolled'
356
- | 'other'
357
- /** @enum {string} */
358
- EmploymentPayFrequency: 'weekly' | 'biweekly' | 'twice_monthly' | 'monthly'
359
- /** @enum {string} */
360
- EmploymentStatus:
361
- | 'employed'
362
- | 'employed_full_time'
363
- | 'employed_part_time'
364
- | 'military'
365
- | 'not_employed'
366
- | 'self_employed'
367
- | 'retired'
368
- | 'other'
369
- EventData:
370
- | components['schemas']['ApiApprovedEventData']
371
- | components['schemas']['ApiRejectedEventData']
372
- | components['schemas']['AppliedEventData']
373
- | components['schemas']['ApprovedEventData']
374
- | components['schemas']['ConversionEventData']
375
- | components['schemas']['FundedEventData']
376
- | components['schemas']['ListedEventData']
377
- | components['schemas']['OfferClickedEventData']
378
- | components['schemas']['OpenedEventData']
379
- /** @enum {string} */
380
- EventType:
381
- | 'leadCreated'
382
- | 'appSubmitted'
383
- | 'apiApproved'
384
- | 'apiRejected'
385
- | 'offerClicked'
386
- | 'lenderQualifiedLead'
387
- | 'applied'
388
- | 'approved'
389
- | 'listed'
390
- | 'opened'
391
- | 'funded'
392
- | 'conversion'
393
- FeaturedFinancialInstitution: {
394
- /**
395
- * Format: uuid
396
- * @description A unique identifier for the financial institution.
397
- */
398
- uuid: string
399
- /**
400
- * @description The name of the financial institution. This value is subject to
401
- * change, so `financialInstitutionUuid` should be used for grouping.
402
- */
403
- name: string
404
- /**
405
- * Format: url
406
- * @description The URL of an image logo for the associated financial institution.
407
- */
408
- logoUrl: string
409
- }
410
- /** @enum {string} */
411
- FederalInsuranceType: 'fdic' | 'ncua'
412
- FinancialInstitutionLoanReport: {
413
- /**
414
- * Format: uuid
415
- * @description The unique identifier for the financial institution.
416
- */
417
- uuid: string
418
- /** @description The name of the financial institution. */
419
- name: string
420
- /** @description A URL of a logo for the financial institution. */
421
- logoUrl?: string
422
- /** @description The approval probabilities for the financial intitution. */
423
- probabilities: components['schemas']['LoanProbability'][]
424
- }
425
- /** funded */
426
- FundedEventData: {
427
- /**
428
- * Format: int32
429
- * @description The dollar amount of the offer that was funded.
430
- */
431
- amount?: number
432
- /** @description The product type of the funded offer. */
433
- productType?: components['schemas']['ProductType']
434
- }
435
- /** @enum {string} */
436
- IdType: 'driver_license' | 'state_id' | 'passport'
437
- IncentiveDetails: {
438
- /** Format: double */
439
- amount: number
440
- unit: components['schemas']['IncentiveUnit']
441
- display: string
442
- type: components['schemas']['IncentiveType']
443
- }
444
- /**
445
- * @description Unit of measure for incentives.
446
- *
447
- * @enum {string}
448
- */
449
- IncentiveType: 'cash_back' | 'other'
450
- /**
451
- * @description Unit of measure for incentives.
452
- *
453
- * @enum {string}
454
- */
455
- IncentiveUnit: 'usd' | 'other'
456
- /** @enum {string} */
457
- GraduateDegreeType:
458
- | 'doctor_of_medicine'
459
- | 'doctor_of_osteopathic_medicine'
460
- | 'doctor_of_optometry'
461
- | 'doctor_of_dental_medicine'
462
- | 'dentariae_medicinae_doctoris'
463
- | 'doctor_of_dental_surgery'
464
- | 'doctor_of_veterinary_medicine'
465
- | 'doctor_of_pharmacy'
466
- | 'veterinariae_medicinae_doctoris'
467
- | 'master_of_arts'
468
- | 'master_of_science'
469
- | 'master_of_research'
470
- | 'master_of_research_project'
471
- | 'master_of_studies'
472
- | 'master_of_business_administration'
473
- | 'master_of_library_science'
474
- | 'master_of_public_administration'
475
- | 'master_of_public_health'
476
- | 'master_of_laws'
477
- | 'master_of_arts_liberal_studies'
478
- | 'master_of_fine_arts'
479
- | 'master_of_music'
480
- | 'master_of_education'
481
- | 'master_of_engineering'
482
- | 'master_of_architecture'
483
- | 'juris_doctor'
484
- | 'other'
485
- /** @enum {string} */
486
- Gender: 'male' | 'female'
487
- /** @enum {string} */
488
- IntroOfferType: 'miles' | 'points' | 'statement_credit'
489
- Lead: {
490
- /** @description Name of company which provided the lead */
491
- leadProviderName: string
492
- personalInformation?: components['schemas']['LeadPersonalInformation']
493
- personalReferenceInformation?: components['schemas']['PersonalReferenceInformation']
494
- loanInformation?: components['schemas']['LeadLoanInformation']
495
- mortgageInformation?: components['schemas']['LeadMortgageInformation']
496
- creditCardInformation?: components['schemas']['LeadCreditCardInformation']
497
- savingsInformation?: components['schemas']['LeadSavingsInformation']
498
- creditInformation?: components['schemas']['LeadCreditInformation']
499
- financialInformation?: components['schemas']['LeadFinancialInformation']
500
- employmentInformation?: components['schemas']['LeadEmploymentInformation']
501
- legalInformation?: components['schemas']['LeadLegalInformation']
502
- educationInformation?: components['schemas']['LeadEducationInformation']
503
- coApplicantInformation?: components['schemas']['LeadCoApplicantInformation']
504
- healthInformation?: components['schemas']['LeadHealthInformation']
505
- identificationInformation?: components['schemas']['LeadIdentificationInformation']
506
- refinanceLoans?: components['schemas']['RefinanceLoanInformation'][]
507
- clientTags?: components['schemas']['ClientTags']
508
- sessionInformation?: components['schemas']['LeadSessionInformation']
509
- leadActions?: components['schemas']['LeadAction'][]
510
- /**
511
- * Format: uuid
512
- * @description Primary UUID for a `Lead`
513
- */
514
- uuid: string
515
- /**
516
- * Format: uuid
517
- * @description UUID for a company which created the `Lead`
518
- */
519
- companyUUID: string
520
- /**
521
- * Format: uuid
522
- * @description UUID used to link leads across verticals, unique per user per supply sub-account
523
- */
524
- sessionUuid?: string
525
- /**
526
- * Format: uuid
527
- * @description Unique identifier for the lead's device.
528
- */
529
- deviceId?: string
530
- /**
531
- * Format: uuid
532
- * @deprecated
533
- */
534
- referralCompanyUuid?: string
535
- /** Format: uuid */
536
- trackingUuid?: string
537
- /** @description Whether a `Lead` was created using a test access token */
538
- isTest: boolean
539
- /** @description The furthest step of the funnel a `Lead` has reached */
540
- status: components['schemas']['LeadActionType']
541
- createdAt: string
542
- updatedAt: string
543
- }
544
- /** @enum {string} */
545
- LeadBestTimeToCall: 'morning' | 'afternoon' | 'evening' | 'night'
546
- /**
547
- * @description The personal information of a co-applicant that may be considered in the
548
- * underwriting and approval of a loan.
549
- */
550
- LeadCoApplicantInformation: {
551
- firstName?: string
552
- lastName?: string
553
- /** Format: date */
554
- dateOfBirth?: string
555
- /** Format: int32 */
556
- annualIncome?: number
557
- /** @description Street address (primary address line) */
558
- streetAddress1?: string
559
- /** @description Secondary address line */
560
- streetAddress2?: string
561
- city?: string
562
- state?: components['schemas']['State']
563
- zipcode?: string
564
- }
565
- /** @description Credit history information relating to a `Lead` */
566
- LeadCreditInformation: {
567
- providedCreditRating?: components['schemas']['ProvidedCreditRating']
568
- /**
569
- * Format: int32
570
- * @description FICO credit score provided by a `Lead`
571
- */
572
- providedNumericCreditScore?: number
573
- }
574
- LeadCreditCardInformation: {
575
- allowAnnualFee?: boolean
576
- /** @description A list of card purposes in which the lead is interested */
577
- cardPurposes?: components['schemas']['CardPurpose'][]
578
- }
579
- LeadClientTagsResponse: {
580
- /** @description A URL which identifies where the next batch of LeadClientTags can be queried for. */
581
- nextUrl: string
582
- /**
583
- * @description If true, data is currently available at `nextUrl`.
584
- * Calling the `nextUrl` at the current time will return the next batch of data.
585
- * If false, calling `nextUrl` at the current time will return an error response from the API.
586
- * Data will be made available at a later time (at the next hour mark).
587
- */
588
- shouldContinuePolling: boolean
589
- /** @description Lead client tag data for the requested time window. */
590
- data: components['schemas']['LeadClientTag'][]
591
- }
592
- LeadClientTag: {
593
- /** @description A unique hash for the client tag to assist with deduplication. */
594
- hash: string
595
- /**
596
- * Format: uuid
597
- * @description The UUID of the lead that this client tag belongs to.
598
- */
599
- leadUuid: string
600
- /** @description The key of this client tag. */
601
- key: string
602
- /** @description The latest value for the client tag key. */
603
- value: string
604
- /**
605
- * Format: date-time
606
- * @description The time that this client tag was added to the lead.
607
- */
608
- createdAt: string
609
- }
610
- /**
611
- * @example {
612
- * "summary": "A lead request",
613
- * "value": {
614
- * "productTypes": [
615
- * "loan",
616
- * "savings"
617
- * ],
618
- * "personalInformation": {
619
- * "firstName": "John",
620
- * "lastName": "Doe",
621
- * "email": "john@example.com",
622
- * "city": "New York",
623
- * "state": "NY",
624
- * "workPhone": "2125551234",
625
- * "primaryPhone": "2125556789",
626
- * "address1": "45 West 21st Street",
627
- * "address2": "5th Floor",
628
- * "zipcode": "10010",
629
- * "monthsAtAddress": 5,
630
- * "driversLicenseNumber": "111222333",
631
- * "driversLicenseState": "NY",
632
- * "ipAddress": "8.8.8.8",
633
- * "activeMilitary": false,
634
- * "militaryVeteran": true,
635
- * "dateOfBirth": "1993-10-09",
636
- * "ssn": "111-22-3333"
637
- * },
638
- * "loanInformation": {
639
- * "purpose": "debt_consolidation",
640
- * "loanAmount": 10000
641
- * },
642
- * "mortgageInformation": {
643
- * "propertyType": "condo",
644
- * "propertyStatus": "own_with_mortgage",
645
- * "propertyValue": 200000,
646
- * "mortgageBalance": 10000,
647
- * "lenderName": "Bank OF NY",
648
- * "hasFHALoan": true,
649
- * "currentWithLoan": true
650
- * },
651
- * "creditCardInformation": {
652
- * "allowAnnualFee": true,
653
- * "cardPurposes": [
654
- * "travel_incentives"
655
- * ]
656
- * },
657
- * "savingsInformation": {
658
- * "minDepositAmount": 1000
659
- * },
660
- * "creditInformation": {
661
- * "providedCreditRating": "excellent",
662
- * "providedNumericCreditScore": 750
663
- * },
664
- * "financialInformation": {
665
- * "creditCardDebt": 5000,
666
- * "employmentStatus": "employed",
667
- * "employmentPayFrequency": "weekly",
668
- * "annualIncome": 120000,
669
- * "monthlyNetIncome": 10000,
670
- * "bankName": "Santander",
671
- * "bankRoutingNumber": "231372691",
672
- * "bankAccountType": "savings",
673
- * "monthsAtBank": 10,
674
- * "bankAccountNumber": "1234567890"
675
- * },
676
- * "employmentInformation": {
677
- * "employerName": "Engine by MoneyLion",
678
- * "employerAddress": "45 W 21st St",
679
- * "employerCity": "New York",
680
- * "employerState": "NY",
681
- * "employerZip": "10010",
682
- * "jobTitle": "Software Engineer",
683
- * "monthsEmployed": 14,
684
- * "directDeposit": true,
685
- * "payDate1": "2004-10-06",
686
- * "payDate2": "2004-11-06"
687
- * },
688
- * "educationInformation": {
689
- * "educationLevel": "masters",
690
- * "graduateDegreeType": "master_of_science",
691
- * "universityAttended": "Johns Hopkins University"
692
- * },
693
- * "coApplicantInformation": {
694
- * "firstName": "Jane",
695
- * "lastName": "Doe",
696
- * "dateOfBirth": "1984-03-06",
697
- * "annualIncome": 100000,
698
- * "streetAddress1": "45 West 21st Street",
699
- * "streetAddress2": "5th Floor",
700
- * "city": "New York",
701
- * "state": "NY",
702
- * "zipcode": "10010"
703
- * },
704
- * "healthInformation": {
705
- * "gender": "male",
706
- * "heightInInches": 72,
707
- * "weightInPounds": 195,
708
- * "tobaccoSmoker": false
709
- * },
710
- * "legalInformation": {
711
- * "consentsToFcra": true,
712
- * "consentsToTcpa": true,
713
- * "fcraLanguage": "By checking this box/clicking 'agree' I hereby consent to the 'E-Sign Agreement', the 'Credit Authorization Agreement', the Terms of Service and Privacy Policy, and I am providing written consent under the Fair Credit Reporting Act (FCRA) for [Engine by MoneyLion and/or Insert Company Name], its partners and financial institutions to obtain consumer report information from my credit profile. I request that my information be provided to their partners, lenders, and financial services partners to provide me with financial recommendations, which may also include debt relief, credit repair, credit monitoring or other related services",
714
- * "tcpaLanguage": "I agree to be contacted by [Engine by MoneyLion and/or Insert Company Name] its partners and their affiliated companies and financial institutions via email, postal mail service and/or at the telephone number(s) I have provided above to explore various financial products and services I inquired about, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. Consent is not required as a condition to utilize the service, and you may choose to be contacted by an individual customer care representative(s) by calling XXXXX or emailing XXXX"
715
- * },
716
- * "clientTags": {
717
- * "hello": [
718
- * "world",
719
- * "there"
720
- * ],
721
- * "something": [
722
- * "else"
723
- * ]
724
- * }
725
- * }
726
- * }
727
- */
728
- LeadCreateData: {
729
- /** @description Product types in which the `Lead` is interested */
730
- productTypes?: components['schemas']['ProductType'][]
731
- /**
732
- * Format: uuid
733
- * @description Primary UUID for a `Lead`
734
- */
735
- uuid?: string
736
- /**
737
- * Format: uuid
738
- * @description UUID used to link leads across verticals, unique per user per supply sub-account
739
- */
740
- sessionUuid?: string
741
- /**
742
- * Format: uuid
743
- * @description Unique identifier for the lead's device.
744
- */
745
- deviceId?: string
746
- loanInformation?: components['schemas']['LeadLoanInformation']
747
- personalInformation?: components['schemas']['LeadPersonalInformation']
748
- personalReferenceInformation?: components['schemas']['PersonalReferenceInformation']
749
- mortgageInformation?: components['schemas']['LeadMortgageInformation']
750
- creditCardInformation?: components['schemas']['LeadCreditCardInformation']
751
- savingsInformation?: components['schemas']['LeadSavingsInformation']
752
- creditInformation?: components['schemas']['LeadCreditInformation']
753
- financialInformation?: components['schemas']['LeadFinancialInformation']
754
- employmentInformation?: components['schemas']['LeadEmploymentInformation']
755
- legalInformation?: components['schemas']['LeadLegalInformation']
756
- educationInformation?: components['schemas']['LeadEducationInformation']
757
- coApplicantInformation?: components['schemas']['LeadCoApplicantInformation']
758
- healthInformation?: components['schemas']['LeadHealthInformation']
759
- /** @description One or more loans that the lead wishes to refinance or consolidate */
760
- refinanceLoans?: components['schemas']['RefinanceLoanInformation'][]
761
- identificationInformation?: components['schemas']['LeadIdentificationInformation']
762
- clientTags?: components['schemas']['ClientTags']
763
- sessionInformation?: components['schemas']['LeadSessionInformation']
764
- /**
765
- * @deprecated
766
- * @description Whether the `Lead` has completed an application form
767
- */
768
- formCompleted?: boolean
769
- /**
770
- * Format: uuid
771
- * @deprecated
772
- * @description UUID of company from which the `Lead` was referred
773
- */
774
- referralCompanyUuid?: string
775
- /**
776
- * Format: uuid
777
- * @deprecated
778
- * @description UUID for internal Engine by MoneyLion tracking purposes. This field should never be set by 3rd party API consumers
779
- */
780
- trackingUuid?: string
781
- }
782
- LeadEducationInformation: {
783
- educationLevel?: components['schemas']['EducationLevel']
784
- graduateDegreeType?: components['schemas']['GraduateDegreeType']
785
- /**
786
- * @deprecated
787
- * @description Name of university where a lead received their undergraduate degree.
788
- * A lookup service for possible universities is available from using the /leads/universities endpoint.
789
- * To maximize returned offers, this string must match one of the names returned from the lookup.
790
- */
791
- universityAttended?: string
792
- universityOpeId?: components['schemas']['OpeId']
793
- /**
794
- * Format: date
795
- * @deprecated
796
- * @description Date the lead graudated from undergrad (YYYY-MM-DD)
797
- */
798
- graduationDate?: string
799
- /**
800
- * Format: date
801
- * @description Lead's graduate school graduation date (YYYY-MM-DD)
802
- */
803
- graduateGraduationDate?: string
804
- /**
805
- * Format: date
806
- * @description Lead's last attended month/year for graduate school (YYYY-MM-DD)
807
- */
808
- graduateLastAttendedDate?: string
809
- /**
810
- * @description Name of university where a lead received their graduate degree.
811
- * A lookup service for possible universities is available from using the /leads/universities endpoint.
812
- * To maximize returned offers, this string must match one of the names returned from the lookup.
813
- */
814
- graduateUniversityAttended?: string
815
- graduateUniversityOpeId?: components['schemas']['OpeId']
816
- /**
817
- * Format: date
818
- * @description Date the lead graduated from undergrad (YYYY-MM-DD).
819
- */
820
- undergraduateGraduationDate?: string
821
- /**
822
- * Format: date
823
- * @description Lead's last attended month/year for undergrad (YYYY-MM-DD)
824
- */
825
- undergraduateLastAttendedDate?: string
826
- /**
827
- * @description Name of university where a lead received their undergraduate degree.
828
- * A lookup service for possible universities is available from using the /leads/universities endpoint.
829
- * To maximize returned offers, this string must match one of the names returned from the lookup.
830
- */
831
- undergraduateUniversityAttended?: string
832
- undergraduateUniversityOpeId?: components['schemas']['OpeId']
833
- }
834
- LeadEducationLevel: components['schemas']['EducationLevel']
835
- LeadEmploymentInformation: {
836
- employerName?: string
837
- employerAddress?: string
838
- employerAddress2?: string
839
- employerCity?: string
840
- employerPhone?: string
841
- employerState?: string
842
- employerZip?: string
843
- jobTitle?: string
844
- /** Format: int32 */
845
- monthsEmployed?: number
846
- /** @description Whether a `Lead` uses direct deposit for their salary */
847
- directDeposit?: boolean
848
- /** Format: date */
849
- payDate1?: string
850
- /** Format: date */
851
- payDate2?: string
852
- /**
853
- * Format: date
854
- * @description The date the lead started working at their current employer (YYYY-MM-DD)
855
- */
856
- startDate?: string
857
- }
858
- LeadFinancialInformation: {
859
- employmentStatus?: components['schemas']['EmploymentStatus']
860
- employmentPayFrequency?: components['schemas']['EmploymentPayFrequency']
861
- /** Format: int32 */
862
- annualIncome?: number
863
- /** Format: int32 */
864
- monthlyNetIncome?: number
865
- bankName?: string
866
- bankRoutingNumber?: string
867
- bankAccountType?: components['schemas']['BankAccountType']
868
- /** Format: int32 */
869
- creditCardDebt?: number
870
- /** Format: int32 */
871
- monthsAtBank?: number
872
- bankAccountNumber?: string
873
- /** Format: int32 */
874
- monthlyDebt?: number
875
- /** Format: int32 */
876
- totalAssets?: number
877
- /** Format: int32 */
878
- monthlyHousingPayment?: number
879
- /** Format: int32 */
880
- availableAssets?: number
881
- /**
882
- * Format: int32
883
- * @description The amount of additional income the lead recieves
884
- */
885
- additionalIncome?: number
886
- /** @description The frequency the lead recieves additional income */
887
- additionalIncomeFrequency?: components['schemas']['EmploymentPayFrequency']
888
- /** @description Do you have a direct deposit? */
889
- hasDirectDeposit?: boolean
890
- /**
891
- * Format: int32
892
- * @description Approximate total unsecured debt in dollars
893
- */
894
- totalUnsecuredDebt?: number
895
- }
896
- LeadHealthInformation: {
897
- gender?: components['schemas']['Gender']
898
- /** Format: int32 */
899
- heightInInches?: number
900
- /** Format: int32 */
901
- weightInPounds?: number
902
- tobaccoSmoker?: boolean
903
- }
904
- LeadIdentificationInformation: {
905
- /** @description The ID number supplied by the lead */
906
- idNumber?: string
907
- /** @description The state of issue of the supplied ID */
908
- idState?: string
909
- /** @description The form of the ID number supplied by the lead */
910
- idType?: components['schemas']['IdType']
911
- }
912
- /** @description Information regarding a `Lead`'s communication concent */
913
- LeadLegalInformation: {
914
- /** @description Whether the lead was shown, and consented to a Fair Credit Reporting Act notice */
915
- consentsToFcra?: boolean
916
- /** @description The lead agrees to recieve SMS text messages from the Financial Institution */
917
- consentsToSms?: boolean
918
- /** @description Whether the lead was shown, and consented to a Telephone Consumer Protection Act notice */
919
- consentsToTcpa?: boolean
920
- /** @description The exact FCRA language to which the lead consented */
921
- fcraLanguage?: string
922
- /** @description The exact TCPA language to which the lead consented */
923
- tcpaLanguage?: string
924
- }
925
- LeadLoanInformation: {
926
- purpose?: components['schemas']['LoanPurpose']
927
- /** Format: int32 */
928
- loanAmount?: number
929
- }
930
- LeadMortgageInformation: {
931
- propertyType?: components['schemas']['PropertyType']
932
- /** Format: int32 */
933
- propertyValue?: number
934
- /** Format: int32 */
935
- mortgageBalance?: number
936
- lenderName?: string
937
- hasFHALoan?: boolean
938
- currentWithLoan?: boolean
939
- propertyStatus?: components['schemas']['PropertyStatus']
940
- mortgageType?: components['schemas']['MortgageType']
941
- /**
942
- * Format: int32
943
- * @description Amount the lead will borrow
944
- */
945
- mortgageAmount?: number
946
- /** Format: int32 */
947
- downPaymentAmount?: number
948
- propertyState?: string
949
- propertyCounty?: string
950
- /** @description Street address (primary address line) */
951
- propertyAddress1?: string
952
- /** @description Secondary address line */
953
- propertyAddress2?: string
954
- propertyZipcode?: string
955
- propertyCity?: string
956
- /**
957
- * Format: int32
958
- * @description Amount the lead will borrow for refinancing an existing mortgage
959
- */
960
- refinanceAmount?: number
961
- /**
962
- * Format: int32
963
- * @description Additional amount the lead will borrow against existing home equity in the case of refinance
964
- */
965
- cashOutAmount?: number
966
- occupancyType?: components['schemas']['OccupancyType']
967
- refinanceType?: components['schemas']['RefinanceType']
968
- propertySearchStatus?: components['schemas']['PropertySearchStatus']
969
- /**
970
- * Format: int32
971
- * @description The number of legal units on the property
972
- */
973
- numUnits?: number
974
- /** Format: date */
975
- closingDate?: string
976
- purchaseStatus?: components['schemas']['PurchaseStatus']
977
- /** Format: date */
978
- purchaseDate?: string
979
- /**
980
- * Format: float
981
- * @description The amount of the HOA fee for the lead
982
- */
983
- monthlyHoaFee?: number
984
- /** @description The name of the company holding the lead's mortgage */
985
- mortgageCompany?: string
986
- /**
987
- * Format: float
988
- * @description The amount of escrow the lead pays
989
- */
990
- mortgageEscrowAmount?: number
991
- }
992
- LeadPersonalInformation: {
993
- firstName?: string
994
- lastName?: string
995
- /** @description The first name the lead uses as an alias */
996
- aliasFirstName?: string
997
- /** @description The last name the lead uses as an alias */
998
- aliasLastName?: string
999
- /** Format: email */
1000
- email?: string
1001
- city?: string
1002
- state?: components['schemas']['State']
1003
- workPhone?: string
1004
- primaryPhone?: string
1005
- bestTimeToCall?: components['schemas']['LeadBestTimeToCall']
1006
- /** @description Street address (primary address line) */
1007
- address1?: string
1008
- /** @description Secondary address line */
1009
- address2?: string
1010
- /**
1011
- * Format: date
1012
- * @description The date the lead moved into their current address
1013
- */
1014
- addressMoveInDate?: string
1015
- zipcode?: string
1016
- /**
1017
- * Format: int32
1018
- * @description Number of months the provided address has been the lead's primary residence
1019
- */
1020
- monthsAtAddress?: number
1021
- driversLicenseNumber?: string
1022
- /** @description State in which the driver's license was issued */
1023
- driversLicenseState?: string
1024
- /**
1025
- * Format: ip
1026
- * @description IP address
1027
- */
1028
- ipAddress?: string
1029
- /** @description Whether the lead is currently in the military (not a veteran) */
1030
- activeMilitary?: boolean
1031
- /** @description Whether the lead is a veteran (should not be used if the lead is active in the military) */
1032
- militaryVeteran?: boolean
1033
- /** Format: date */
1034
- dateOfBirth?: string
1035
- /** @deprecated */
1036
- educationLevel?: components['schemas']['EducationLevel']
1037
- ssn?: string
1038
- citizenshipStatus?: components['schemas']['CitizenshipStatus']
1039
- }
1040
- LeadSavingsInformation: {
1041
- /**
1042
- * Format: int64
1043
- * @description The minimum amount a `Lead` is interested in depositing when opening a new savings account
1044
- */
1045
- minDepositAmount?: number
1046
- /**
1047
- * Format: int64
1048
- * @description The maximum amount a `Lead` is interested in depositing when opening a new savings account
1049
- */
1050
- maxDepositAmount?: number
1051
- }
1052
- /** @description Browsing session information accociated with a `Lead` */
1053
- LeadSessionInformation: {
1054
- ipAddress?: string
1055
- userAgent?: string
1056
- browserFingerprint?: string
1057
- }
1058
- LeadAction: {
1059
- /** Format: uuid */
1060
- uuid: string
1061
- actionType: components['schemas']['LeadActionType']
1062
- /** Format: date-time */
1063
- actionDate: string
1064
- originatorKey?: string
1065
- /** Format: int64 */
1066
- demandSubAccountId: number
1067
- rejectReason?: components['schemas']['RejectReason']
1068
- /** Format: int32 */
1069
- amount?: number
1070
- /** Format: int32 */
1071
- originationFee?: number
1072
- /** Format: int64 */
1073
- offerClickId?: number
1074
- /** Format: date-time */
1075
- createdAt: string
1076
- /** Format: date-time */
1077
- deletedAt?: string
1078
- }
1079
- /** @enum {string} */
1080
- LeadActionType:
1081
- | 'initialized'
1082
- | 'api_rejected'
1083
- | 'api_approved'
1084
- | 'api_listing'
1085
- | 'clicked_referral_link'
1086
- | 'clicked_special_offer_link'
1087
- | 'special_offer_conversion'
1088
- | 'applied'
1089
- | 'rejected'
1090
- | 'approved'
1091
- | 'listed'
1092
- | 'funded'
1093
- | 'not_funded'
1094
- | 'clicked_credit_card_offer_link'
1095
- | 'clicked_mortgage_offer_link'
1096
- | 'clicked_savings_offer_link'
1097
- | 'lender_qualified_lead'
1098
- LeadEvent: {
1099
- /** @description A hash of the `leadUuid`, `eventType` and `eventCreatedAt` which uniquely identifies a leadEvent. */
1100
- id: string
1101
- /**
1102
- * Format: uuid
1103
- * @description The unique identifier for the associated lead.
1104
- */
1105
- leadUuid: string
1106
- /**
1107
- * Format: date-time
1108
- * @description The time that the associated lead was created.
1109
- */
1110
- leadCreatedAt: string
1111
- eventType: components['schemas']['EventType']
1112
- /**
1113
- * Format: date-time
1114
- * @description The time that the event occurred.
1115
- */
1116
- eventCreatedAt: string
1117
- /** @description Supplemental data about the event that is specific to the `eventType`. For events that occur in a financial institution's experience, the availability of the data may vary depending on the FI. */
1118
- eventData?: components['schemas']['EventData']
1119
- /**
1120
- * Format: int32
1121
- * @description The amount of liquidity provided to the end user by the FI. Only present for some events.
1122
- */
1123
- amountInCents?: number
1124
- /**
1125
- * Format: uuid
1126
- * @description A unique identifier for the associated financial institution. Only present for event types associated with financial institutions.
1127
- */
1128
- financialInstitutionUuid?: string
1129
- /** @description The name of the associated financial institution. This value is subject to change, so `financialInstitutionUuid` should be used as a stable identifier. Only present for event types associated with financial institutions. */
1130
- financialInstitutionName?: string
1131
- /** @description The product type for the associated offer. Only present for event types associated with offers. */
1132
- productType?: components['schemas']['ProductType']
1133
- /** @description Whether a `Lead` was created using a test access token */
1134
- isTest: boolean
1135
- }
1136
- LeadEventResponse: {
1137
- /** @description The URL for the next request. */
1138
- nextUrl: string
1139
- /**
1140
- * @description If true, data is currently available at `nextUrl`.
1141
- * Calling the `nextUrl` at the current time will return the next batch of data.
1142
- * If false, calling `nextUrl` at the current time will return an error response from the API.
1143
- * Data will be made available at a later time (at the next hour mark).
1144
- */
1145
- shouldContinuePolling: boolean
1146
- /** @description Lead event data for the requested time window. */
1147
- data: components['schemas']['LeadEvent'][]
1148
- }
1149
- LeadPayout: {
1150
- /**
1151
- * Format: uuid
1152
- * @description The unique identifier for the associated lead.
1153
- */
1154
- leadUuid: string
1155
- /**
1156
- * Format: date-time
1157
- * @description The time that this payout to a supply partner was booked.
1158
- */
1159
- bookedAt: string
1160
- /**
1161
- * Format: double
1162
- * @description The payout amount in cents made available to the supply partner. May be fractional.
1163
- */
1164
- payoutInCents?: number
1165
- /**
1166
- * Format: uuid
1167
- * @description The unique identifier for the associated payout event.
1168
- */
1169
- uuid?: string
1170
- /**
1171
- * Format: date-time
1172
- * @description If a payout to a supply partner was revoked, this value will report the time that the payout was revoked.
1173
- */
1174
- deletedAt?: string
1175
- /** @description The name of the associated financial institution. This value is subject to change, so `financialInstitutionUuid` should be used as a stable identifier. */
1176
- financialInstitutionName?: string
1177
- /**
1178
- * Format: uuid
1179
- * @description A unique identifier for the associated financial institution.
1180
- */
1181
- financialInstitutionUuid?: string
1182
- }
1183
- LeadPayoutResponse: {
1184
- /** @description The URL for the next request. */
1185
- nextUrl: string
1186
- /**
1187
- * @description If true, data is currently available at `nextUrl`.
1188
- * Calling the `nextUrl` at the current time will return the next batch of data.
1189
- * If false, calling `nextUrl` at the current time will return an error response from the API.
1190
- * Data will be made available at a later time (at the next hour mark).
1191
- */
1192
- shouldContinuePolling: boolean
1193
- /** @description Lead payout data for the requested time window. */
1194
- data: components['schemas']['LeadPayout'][]
1195
- }
1196
- LeadUuid: {
1197
- /**
1198
- * Format: uuid
1199
- * @description UUID corresponding to the created `Lead`
1200
- */
1201
- uuid: string
1202
- }
1203
- /** @description An offer for a life insurance lead */
1204
- LifeInsuranceOffer: WithRequired<
1205
- {
1206
- details: components['schemas']['LifeInsuranceOfferDetails']
1207
- } & components['schemas']['Offer'],
1208
- 'details'
1209
- >
1210
- LifeInsuranceOfferDetails: {
1211
- /**
1212
- * Format: int64
1213
- * @description Policy amount, in dollars
1214
- */
1215
- policyAmount: number
1216
- /** Format: int64 */
1217
- termLength?: number
1218
- termUnit?: components['schemas']['TermUnit']
1219
- /** @description Monthly premium amount, in dollars */
1220
- monthlyPremiumAmount: number
1221
- /** @description Annual premium amount, in dollars */
1222
- annualPremiumAmount?: number
1223
- /** @description Semi-annual premium amount, in dollars */
1224
- semiAnnualPremiumAmount?: number
1225
- /** @description Online application is available */
1226
- onlineAppAvailable?: boolean
1227
- noMedicalTest?: boolean
1228
- packageType?: components['schemas']['PackageType']
1229
- /** @description Policy is recommended */
1230
- recommended?: boolean
1231
- medicalExam?: components['schemas']['MedicalExam']
1232
- /** @description The name of policy */
1233
- policyName?: string
1234
- carrierDecisionType?: components['schemas']['CarrierDecisionType']
1235
- partnerQuoteId?: string
1236
- convertToPermanent?: boolean
1237
- childRider?: string
1238
- acceleratedDeathBenefit?: boolean
1239
- waiverOfPremium?: string
1240
- isOnlineApplication?: boolean
1241
- deliveryMethod?: string
1242
- examRequired?: string
1243
- }
1244
- /** listed */
1245
- ListedEventData: {
1246
- /**
1247
- * Format: int32
1248
- * @description The dollar amount of the offer that was listed.
1249
- */
1250
- amount?: number
1251
- /** @description The product type of the offer that was listed. */
1252
- productType?: components['schemas']['ProductType']
1253
- }
1254
- LoanOffer: {
1255
- /** Format: uuid */
1256
- uuid: string
1257
- productType: components['schemas']['ProductType']
1258
- productSubType: components['schemas']['ProductSubType']
1259
- productSubTypeDisclaimer?: string
1260
- /** Format: url */
1261
- url?: string
1262
- originator: components['schemas']['Originator']
1263
- originatorId?: string
1264
- preQualified: boolean
1265
- preApproved: boolean
1266
- secured: boolean
1267
- coApplicant: boolean
1268
- /** @deprecated */
1269
- sponsored: boolean
1270
- /** Format: int32 */
1271
- maxAmount: number
1272
- /** Format: int32 */
1273
- minAmount?: number
1274
- /** Format: int32 */
1275
- termLength: number
1276
- termUnit: components['schemas']['TermUnit']
1277
- displayTermUnit?: string
1278
- termDescription?: string
1279
- maxApr?: number
1280
- minApr?: number
1281
- meanApr?: number
1282
- aprType: components['schemas']['AprType']
1283
- aprDescription?: string
1284
- /**
1285
- * @deprecated
1286
- * @description The maximum percent of loan amount fee for an offer. `maxFeeRate` should be used instead
1287
- */
1288
- feeRate?: number
1289
- maxFeeRate?: number
1290
- minFeeRate?: number
1291
- /**
1292
- * @deprecated
1293
- * @description The maximum fee, in dollars, for an offer. `maxFeeFixed` should be used instead
1294
- */
1295
- feeFixed?: number
1296
- maxFeeFixed?: number
1297
- minFeeFixed?: number
1298
- allowPrepayment: boolean
1299
- prepaymentFee?: number
1300
- /**
1301
- * @deprecated
1302
- * @description The estimated maximum monthly payment, in dollars, for an offer. `maxMonthlyPayment` should be used instead
1303
- */
1304
- monthlyPayment?: number
1305
- maxMonthlyPayment?: number
1306
- minMonthlyPayment?: number
1307
- monthlyPaymentDescription?: string
1308
- meanMonthlyPayment?: number
1309
- maxTotalPayment?: number
1310
- minTotalPayment?: number
1311
- meanTotalPayment?: number
1312
- recommendationScore?: number
1313
- payout?: number
1314
- conversionProbability?: number
1315
- terms?: string
1316
- /** @description Some loan offers require a prefix (e.g. `up to*`) to be displayed to the left of the displayed loan amount. This is a nullable field that may be up to six characters long. */
1317
- amountPrefix?: string
1318
- }
1319
- /** @enum {string} */
1320
- LoanPurpose:
1321
- | 'auto'
1322
- | 'auto_purchase'
1323
- | 'auto_refinance'
1324
- | 'baby'
1325
- | 'boat'
1326
- | 'business'
1327
- | 'car_repair'
1328
- | 'cosmetic'
1329
- | 'credit_card_refi'
1330
- | 'debt_consolidation'
1331
- | 'emergency'
1332
- | 'engagement'
1333
- | 'green'
1334
- | 'home_improvement'
1335
- | 'home_purchase'
1336
- | 'home_refi'
1337
- | 'household_expenses'
1338
- | 'large_purchases'
1339
- | 'life_event'
1340
- | 'medical_dental'
1341
- | 'motorcycle'
1342
- | 'moving_relocation'
1343
- | 'other'
1344
- | 'rv'
1345
- | 'special_occasion'
1346
- | 'student_loan'
1347
- | 'student_loan_refi'
1348
- | 'taxes'
1349
- | 'unknown'
1350
- | 'vacation'
1351
- | 'wedding'
1352
- LoanProbability: {
1353
- /**
1354
- * Format: double
1355
- * @description The likelihood of approval for loans that match the criteria.
1356
- */
1357
- probability: number
1358
- /**
1359
- * Format: double
1360
- * @description The minimum APR for loans with this approval probability.
1361
- */
1362
- aprPercentMin: number
1363
- /**
1364
- * Format: double
1365
- * @description The maximum APR for loans with this approval probability.
1366
- */
1367
- aprPercentMax: number
1368
- /**
1369
- * Format: int64
1370
- * @description The minimum term length for loans with this approval probability.
1371
- */
1372
- termMonthsMin: number
1373
- /**
1374
- * Format: int64
1375
- * @description The maximum term length for loans with this approval probability.
1376
- */
1377
- termMonthsMax: number
1378
- /** @description The optional loan sub-type of loans with this approval probability. */
1379
- productSubType?: components['schemas']['ProductSubType']
1380
- }
1381
- LoanReport: {
1382
- /**
1383
- * Format: uuid
1384
- * @description A unique identifier for this report.
1385
- */
1386
- uuid: string
1387
- /**
1388
- * Format: int32
1389
- * @description The user's annual income in dollars.
1390
- */
1391
- annualIncome: number
1392
- /** @description The user's credit score range. */
1393
- creditRating: components['schemas']['ProvidedCreditRating']
1394
- /**
1395
- * Format: int32
1396
- * @description The user's total debt in dollars.
1397
- */
1398
- totalDebt?: number
1399
- /**
1400
- * Format: int32
1401
- * @description The number of derogatory accounts listed on the user's credit report.
1402
- */
1403
- countOfDerogatories?: number
1404
- /** @description The user's state of residence. */
1405
- state?: components['schemas']['State']
1406
- /** @description The reason for the loan. */
1407
- loanPurpose?: components['schemas']['LoanPurpose']
1408
- /**
1409
- * Format: int32
1410
- * @description The size of the the loan.
1411
- */
1412
- loanAmount?: number
1413
- /** @description Probabilities for classes of loans, irrespective of financial institution. */
1414
- networkProbabilities: components['schemas']['LoanProbability'][]
1415
- /** @description Probabilities broken out for specific financial institutions. */
1416
- financialInsitutions: components['schemas']['FinancialInstitutionLoanReport'][]
1417
- /**
1418
- * Format: date-time
1419
- * @description When this report was created.
1420
- */
1421
- createdAt: string
1422
- }
1423
- LoanReportCreateData: {
1424
- /**
1425
- * Format: int32
1426
- * @description The user's annual income in dollars.
1427
- */
1428
- annualIncome: number
1429
- /** @description The user's credit score range. */
1430
- creditRating: components['schemas']['ProvidedCreditRating']
1431
- /**
1432
- * Format: int32
1433
- * @description The user's total debt in dollars.
1434
- */
1435
- totalDebt?: number
1436
- /**
1437
- * Format: int32
1438
- * @description The number of derogatory accounts listed on the user's credit report.
1439
- */
1440
- countOfDerogatories?: number
1441
- /** @description The user's state of residence. */
1442
- state?: components['schemas']['State']
1443
- /** @description The reason for the loan. */
1444
- loanPurpose?: components['schemas']['LoanPurpose']
1445
- /**
1446
- * Format: int32
1447
- * @description The size of the the loan.
1448
- */
1449
- loanAmount?: number
1450
- }
1451
- /**
1452
- * @description Medical exam requirement
1453
- * @enum {string}
1454
- */
1455
- MedicalExam: 'no_exam_if_qualified' | 'no_exam_guaranteed' | 'exam_required'
1456
- /** @enum {string} */
1457
- MortgageAdjustmentType: 'credits' | 'par' | 'points'
1458
- /** @enum {string} */
1459
- MortgageLoanType:
1460
- | 'fifteen_year_fixed'
1461
- | 'thirty_year_fixed'
1462
- | 'five_one_adjustable'
1463
- | 'seven_one_adjustable'
1464
- | 'ten_one_adjustable'
1465
- /** @description An offer for a mortgage */
1466
- MortgageOffer: WithRequired<
1467
- {
1468
- details: components['schemas']['MortgageOfferDetails']
1469
- } & components['schemas']['Offer'],
1470
- 'details'
1471
- >
1472
- MortgageOfferDetails: {
1473
- interestRate: number
1474
- loanType: components['schemas']['MortgageLoanType']
1475
- priceAdjustment: number
1476
- monthlyPayment: number
1477
- netClosingCosts: number
1478
- apr: number
1479
- /** Format: int32 */
1480
- loanTerm: number
1481
- adjustmentType: components['schemas']['MortgageAdjustmentType']
1482
- }
1483
- /** @enum {string} */
1484
- MortgageType: 'purchase' | 'refinance'
1485
- /** @enum {string} */
1486
- OccupancyType: 'primary' | 'secondary' | 'investment'
1487
- Offer: {
1488
- /** Format: uuid */
1489
- uuid: string
1490
- partner: components['schemas']['Partner']
1491
- marketplace?: components['schemas']['Partner']
1492
- productType: components['schemas']['ProductType']
1493
- productSubType: components['schemas']['ProductSubType']
1494
- /** Format: url */
1495
- url: string
1496
- recommendationScore?: number
1497
- disclaimer?: string
1498
- productSubTypeDisclaimer?: string
1499
- /** Format: date-time */
1500
- expiresAt?: string
1501
- }
1502
- /** offerClicked */
1503
- OfferClickedEventData: {
1504
- /** @description The product type of the clicked offer. */
1505
- productType?: components['schemas']['ProductType']
1506
- }
1507
- OfferDisplay: {
1508
- /** Format: int64 */
1509
- id: number
1510
- /** Format: uuid */
1511
- uuid: string
1512
- /** Format: uuid */
1513
- leadUuid: string
1514
- /** Format: uuid */
1515
- rateTableUuid: string
1516
- /** Format: uuid */
1517
- offerUuid: string
1518
- /** Format: date-time */
1519
- createdAt: string
1520
- /** Format: uuid */
1521
- createdBy: string
1522
- }
1523
- OfferDisplayCreateData: {
1524
- /** Format: uuid */
1525
- leadUuid: string
1526
- /** Format: uuid */
1527
- rateTableUuid: string
1528
- /** Format: uuid */
1529
- offerUuid: string
1530
- }
1531
- /** @description identification number used by the U.S. Department of Education's Office of Postsecondary Education (OPE) to identify schools that have Program Participation Agreements (PPA) so that its students are eligible to participate in Federal Student Financial Assistance programs under Title IV regulations. This is a 6-digit number followed by a 2-digit suffix used to identify branches, additional locations, and other entities that are part of the eligible institution. */
1532
- OpeId: string
1533
- /** opened */
1534
- OpenedEventData: {
1535
- /** @description The product type of the offer for which the account was opened. */
1536
- productType?: components['schemas']['ProductType']
1537
- }
1538
- Originator: {
1539
- key: string
1540
- name: string
1541
- description?: string
1542
- images: components['schemas']['OriginatorImage'][]
1543
- disclaimer?: string
1544
- /** Format: uuid */
1545
- companyUuid?: string
1546
- /** Format: uuid */
1547
- financialInstitutionUuid?: string
1548
- }
1549
- OriginatorImage: {
1550
- sizeKey: string
1551
- url: string
1552
- }
1553
- /**
1554
- * @description Life insurance package types
1555
- * @enum {string}
1556
- */
1557
- PackageType: 'basic' | 'essential' | 'elite'
1558
- Partner: {
1559
- /** Format: uuid */
1560
- uuid: string
1561
- name: string
1562
- description: string
1563
- disclaimer: string
1564
- supportsPreSelect: boolean
1565
- shouldDisplayPreSelect: boolean
1566
- /** @description Whether the partner supports returning pre-qualified or pre-approved offers */
1567
- supportsPersonalizedOffers: boolean
1568
- /** Format: url */
1569
- imageUrl: string
1570
- subtextOverride?: string
1571
- }
1572
- PendingResponse: {
1573
- partner: components['schemas']['Partner']
1574
- productTypes: components['schemas']['ProductType'][]
1575
- }
1576
- PersonalReferenceInformation: {
1577
- /** @description The first name of the personal reference supplied by the lead */
1578
- firstName?: string
1579
- /** @description The last name of the personal reference supplied by the lead */
1580
- lastName?: string
1581
- /** @description The phone number of the personal reference supplied by the lead */
1582
- primaryPhone?: string
1583
- /** @description The relation of the personal reference supplied by the lead */
1584
- relationType?: components['schemas']['PersonalReferenceRelationType']
1585
- }
1586
- /** @enum {string} */
1587
- PersonalReferenceRelationType:
1588
- | 'parent'
1589
- | 'employer'
1590
- | 'spouse'
1591
- | 'guardian'
1592
- | 'sibling'
1593
- | 'relative'
1594
- | 'friend'
1595
- | 'other'
1596
- /** @enum {string} */
1597
- ProductType:
1598
- | 'credit_card'
1599
- | 'insurance'
1600
- | 'life_insurance'
1601
- | 'loan'
1602
- | 'mortgage'
1603
- | 'savings'
1604
- | 'other'
1605
- /**
1606
- * @description A type of financial product
1607
- * @enum {string}
1608
- */
1609
- ProductSubType:
1610
- | 'credit_card'
1611
- | 'secured_card'
1612
- | 'personal_loan'
1613
- | 'secured_loan'
1614
- | 'student_loan_refinance'
1615
- | 'co_applicant_loan'
1616
- | 'line_of_credit'
1617
- | 'automobile_refinance'
1618
- | 'home_equity_line_of_credit'
1619
- | 'purchase'
1620
- | 'refinance'
1621
- | 'savings_account'
1622
- | 'money_market_account'
1623
- | 'certificate_of_deposit'
1624
- | 'individual_retirement_account'
1625
- | 'cash_management_account'
1626
- | 'high_interest_checking'
1627
- | 'checking'
1628
- | 'accidental_death_benefits'
1629
- | 'term_life'
1630
- | 'term_life_instant'
1631
- | 'whole_life'
1632
- | 'debt_relief'
1633
- | 'installment_loans'
1634
- | 'credit_builder'
1635
- | 'cash_advance'
1636
- | 'credit_repair'
1637
- | 'education_offers'
1638
- | 'employment_opportunity'
1639
- | 'financial_wellness'
1640
- | 'direct_affiliate'
1641
- | 'overdraft_protection'
1642
- | 'revenue_based_financing'
1643
- | 'uncategorized'
1644
- /** @enum {string} */
1645
- ProvidedCreditRating: 'excellent' | 'good' | 'fair' | 'poor' | 'limited' | 'unknown'
1646
- /** @enum {string} */
1647
- PropertyStatus: 'own_outright' | 'own_with_mortgage' | 'rent'
1648
- /** @enum {string} */
1649
- PropertySearchStatus: 'found' | 'not_found'
1650
- /** @enum {string} */
1651
- PropertyType: 'rent' | 'condo' | 'multi_unit' | 'single_family' | 'townhouse'
1652
- /** @enum {string} */
1653
- PurchaseStatus: 'no_offer' | 'offer_accepted' | 'offer_pending' | 'under_contract'
1654
- /** @description A `RateTable` customized to a `Lead` input */
1655
- RateTable: {
1656
- /**
1657
- * Format: uuid
1658
- * @description Primary UUID for a `RateTable`
1659
- */
1660
- uuid: string
1661
- /**
1662
- * Format: uuid
1663
- * @description UUID of the associated `Lead`
1664
- */
1665
- leadUuid: string
1666
- /**
1667
- * Format: int32
1668
- * @description `Lead`'s provided loan amount at the time of `RateTable` creation
1669
- */
1670
- loanAmount?: number
1671
- /**
1672
- * Format: url
1673
- * @description A URL with which to build an iframe to embed rate table offer results in your experience. Only available to channels with integrations configured in control center.
1674
- */
1675
- embedUrl?: string
1676
- /**
1677
- * Format: url
1678
- * @description A partner page URL to send your user to see the rate table offer results. Only available to channels with integrations configured in control center.
1679
- */
1680
- partnerPageUrl?: string
1681
- creditCardOffers: components['schemas']['CreditCardOffer'][]
1682
- loanOffers: components['schemas']['LoanOffer'][]
1683
- mortgageOffers: components['schemas']['MortgageOffer'][]
1684
- savingsOffers: components['schemas']['SavingsOffer'][]
1685
- specialOffers: components['schemas']['SpecialOffer'][]
1686
- /**
1687
- * @deprecated
1688
- * @description List of originators which have been queried, but have not responded yet. This list only contains loan originators, and should no longer be used
1689
- */
1690
- pendingOriginators: components['schemas']['Originator'][]
1691
- /** @description List of demand partners which have been queried, but have not responded yet. It is a guarantee that no offers will be added to the rate table after this list is empty */
1692
- pendingResponses: components['schemas']['PendingResponse'][]
1693
- }
1694
- /** Refinance loan information */
1695
- RefinanceLoanInformation: {
1696
- /** @description The account number for a loan the lead is refinancing */
1697
- accountNumber?: string
1698
- /** @description If the repayment is income-based for a loan the lead is refinancing */
1699
- incomeBasedRepayment?: boolean
1700
- /**
1701
- * Format: float
1702
- * @description The interest rate for a loan the lead is refinancing
1703
- */
1704
- interestRate?: number
1705
- /**
1706
- * Format: int32
1707
- * @description The loan amount for a loan the lead is refinancing
1708
- */
1709
- loanAmount?: number
1710
- /** @description The name of a loan servicer of a loan the lead is refinancing */
1711
- loanServicer?: string
1712
- /** @description The loan type for a loan the lead is refinancing */
1713
- loanType?: components['schemas']['RefinanceLoanType']
1714
- /**
1715
- * Format: float
1716
- * @description The amount the next payment will be on a loan the lead is refinancing
1717
- */
1718
- nextPaymentAmount?: number
1719
- /**
1720
- * Format: date
1721
- * @description The next payment date for a loan the lead is refinancing
1722
- */
1723
- nextPaymentDate?: string
1724
- }
1725
- /** @enum {string} */
1726
- RefinanceLoanType: 'federal_student_loan' | 'private_student_loan'
1727
- /** @enum {string} */
1728
- RefinanceType: 'cash_out' | 'rate_term'
1729
- /** @enum {string} */
1730
- RejectReason:
1731
- | 'low_fico'
1732
- | 'no_fico'
1733
- | 'major_derogatory'
1734
- | 'underwriting_decline'
1735
- | 'debt_to_income_ratio'
1736
- | 'not_in_active_state'
1737
- | 'incorrect_data_provided'
1738
- | 'duplicate'
1739
- /** @description An offer for a savings account */
1740
- SavingsOffer: WithRequired<
1741
- {
1742
- details: components['schemas']['SavingsOfferDetails']
1743
- } & components['schemas']['Offer'],
1744
- 'details'
1745
- >
1746
- SavingsOfferDetails: {
1747
- name?: string
1748
- description?: string
1749
- details?: string
1750
- /** @description Annual interest rate */
1751
- rate?: number
1752
- annualPercentYield: number
1753
- compoundingMethod: components['schemas']['CompoundingMethod']
1754
- /** Format: int32 */
1755
- introductoryPeriodMonths?: number
1756
- introductoryRate?: number
1757
- minimumDeposit: number
1758
- minimumDepositWithFees?: number
1759
- monthlyFee: number
1760
- /** @description Whether the account allows checks */
1761
- checkWriting?: boolean
1762
- /**
1763
- * Format: date-time
1764
- * @description When the offer was last validated, formatted as yyyy-MM-ddTHH:mm:ss.SSSZZ
1765
- */
1766
- effectiveAsOf: string
1767
- /**
1768
- * @description The type of federal deposit insurance that applies to this offer, if
1769
- * it was provided by the financial institution. Could be one of `fdic` for
1770
- * the Federal Deposit Insurance Corporation, or `ncua` for the National
1771
- * Credit Union Administration.
1772
- */
1773
- federalInsuranceType?: components['schemas']['FederalInsuranceType']
1774
- incentiveDetails?: components['schemas']['IncentiveDetails'][]
1775
- cdTermUnit?: components['schemas']['TermUnit']
1776
- /** Format: int32 */
1777
- cdTermLength?: number
1778
- }
1779
- SessionInit: {
1780
- /** Format: int64 */
1781
- id: number
1782
- /** Format: uuid */
1783
- uuid: string
1784
- /** Format: uuid */
1785
- sessionUuid: string
1786
- /** Format: date-time */
1787
- createdAt: string
1788
- /** Format: uuid */
1789
- createdBy: string
1790
- }
1791
- SessionInitCreateData: {
1792
- /**
1793
- * Format: uuid
1794
- * @description You may specify the session's UUID; if you don't, one will be generated for you.
1795
- */
1796
- sessionUuid?: string
1797
- }
1798
- SpecialOffer: {
1799
- /** Format: uuid */
1800
- uuid: string
1801
- name: string
1802
- /** @description Description */
1803
- desc: string
1804
- /** Format: url */
1805
- url: string
1806
- partnerName: string
1807
- /** Format: url */
1808
- partnerImageUrl: string
1809
- recommendationScore?: number
1810
- payout?: number
1811
- productSubType: components['schemas']['ProductSubType']
1812
- disclaimer?: string
1813
- }
1814
- /**
1815
- * state
1816
- * Format: state
1817
- * @description A two character upper case state, Puerto Rico, or District of Columbia code
1818
- * @enum {string}
1819
- */
1820
- State:
1821
- | 'AK'
1822
- | 'AL'
1823
- | 'AR'
1824
- | 'AZ'
1825
- | 'CA'
1826
- | 'CO'
1827
- | 'CT'
1828
- | 'DC'
1829
- | 'DE'
1830
- | 'FL'
1831
- | 'GA'
1832
- | 'HI'
1833
- | 'IA'
1834
- | 'ID'
1835
- | 'IL'
1836
- | 'IN'
1837
- | 'KS'
1838
- | 'KY'
1839
- | 'LA'
1840
- | 'MA'
1841
- | 'MD'
1842
- | 'ME'
1843
- | 'MI'
1844
- | 'MN'
1845
- | 'MO'
1846
- | 'MS'
1847
- | 'MT'
1848
- | 'NC'
1849
- | 'ND'
1850
- | 'NE'
1851
- | 'NH'
1852
- | 'NJ'
1853
- | 'NM'
1854
- | 'NV'
1855
- | 'NY'
1856
- | 'OH'
1857
- | 'OK'
1858
- | 'OR'
1859
- | 'PA'
1860
- | 'PR'
1861
- | 'RI'
1862
- | 'SC'
1863
- | 'SD'
1864
- | 'TN'
1865
- | 'TX'
1866
- | 'UT'
1867
- | 'VA'
1868
- | 'VI'
1869
- | 'VT'
1870
- | 'WA'
1871
- | 'WI'
1872
- | 'WV'
1873
- | 'WY'
1874
- /**
1875
- * @description Unit of measure for offer term lengths, or open for a single term.
1876
- *
1877
- * @enum {string}
1878
- */
1879
- TermUnit: 'day' | 'month' | 'year' | 'open'
1880
- VehicleDetails: {
1881
- /**
1882
- * Format: int32
1883
- * @description Year of the vehicle.
1884
- */
1885
- year: number
1886
- /** @description Make of the vehicle. */
1887
- make: string
1888
- /** @description Model of the vehicle. */
1889
- model: string
1890
- /** @description Trim of the vehicle. */
1891
- trim: string
1892
- /**
1893
- * Format: uuid
1894
- * @description A unique identifier for this vehicle.
1895
- */
1896
- uuid: string
1897
- /**
1898
- * Format: int64
1899
- * @description NADA Used Card Guide vehicle id.
1900
- */
1901
- ucgVehicleId: number
1902
- }
1903
- /** Vehicle information */
1904
- VehicleInformation: {
1905
- /**
1906
- * Format: int32
1907
- * @description The lead's monthly auto loan payment
1908
- */
1909
- monthlyPayment?: number
1910
- /**
1911
- * Format: integer
1912
- * @description The vehicle's estimated number of miles driven
1913
- */
1914
- estimatedMileage?: number
1915
- /** @description The vehicle identification number (VIN) of the financed vehicle */
1916
- vehicleIdentificationNumber?: string
1917
- /**
1918
- * Format: uuid
1919
- * @description A vehicle UUID that corresponds to a valid combination of vehicle year, make, model, and trim. See the [vehicle utility endpoints](https://engine.tech/docs/api-reference/#even-financial-api-ui-utils)
1920
- */
1921
- vehicleUuid?: string
1922
- }
1923
- }
3
+ ApiError: {
4
+ /** @description The attribute that this error applies to. Omitted if this error is not in the context of a resource, or cannot be isolated to a single attribute. */
5
+ attribute?: string;
6
+ /** @description A classification for this error, which can be used to render the appropriate custom error template, or take other programmatic actions. */
7
+ type?: string;
8
+ /** @description Variables associated with this error that can be injected into a custom error template, or used to parameterize any other programatic actions. */
9
+ details?: components["schemas"]["ApiErrorDetails"];
10
+ /** @description A human-readable, English description of the error. */
11
+ message?: string;
12
+ };
13
+ ApiErrorDetails: {
14
+ [key: string]: string;
15
+ };
16
+ /** apiApproved */
17
+ ApiApprovedEventData: {
18
+ /** @description The product type of the approved offer. */
19
+ productType?: components["schemas"]["ProductType"];
20
+ };
21
+ /** apiRejected */
22
+ ApiRejectedEventData: {
23
+ /** @description A normalized reason why the lead was rejected, according to the financial institution. */
24
+ rejectReason?: components["schemas"]["RejectReason"];
25
+ /** @description The product type of the rejected offer. */
26
+ productType?: components["schemas"]["ProductType"];
27
+ };
28
+ /** applied */
29
+ AppliedEventData: {
30
+ /**
31
+ * Format: int32
32
+ * @description The dollar amount of the offer that was applied for.
33
+ */
34
+ amount?: number;
35
+ /** @description The product type of the offer that was applied for. */
36
+ productType?: components["schemas"]["ProductType"];
37
+ };
38
+ /** approved */
39
+ ApprovedEventData: {
40
+ /**
41
+ * Format: int32
42
+ * @description The dollar amount of the approved offer.
43
+ */
44
+ amount?: number;
45
+ /** @description The product type of the approved offer. */
46
+ productType?: components["schemas"]["ProductType"];
47
+ };
48
+ /** @enum {string} */
49
+ AprType: "variable" | "regular" | "fixed";
50
+ /** @enum {string} */
51
+ BankAccountType: "checking" | "savings" | "other";
52
+ /**
53
+ * @description Benefits or benefit categories related to a credit card
54
+ * @enum {string}
55
+ */
56
+ CardBenefit:
57
+ | "No Foreign Transaction Fees"
58
+ | "Purchase Protection"
59
+ | "Return Protection"
60
+ | "Price Protection"
61
+ | "Fraud Protection"
62
+ | "Extended Warranty"
63
+ | "Travel Accident Insurance"
64
+ | "Trip Interruption Insurance"
65
+ | "Car Rental Insurance"
66
+ | "Baggage Insurance"
67
+ | "Baggage Delay Insurance"
68
+ | "Hotel Burglary Insurance"
69
+ | "Travel & Emergency Assistance"
70
+ | "Roadside Assistance"
71
+ | "Concierge Service"
72
+ | "Lounge Access"
73
+ | "Identity Theft Assistance"
74
+ | "In-Flight Savings"
75
+ | "Free Checked Bag"
76
+ | "Priority Boarding"
77
+ | "No Blackout Dates"
78
+ | "Free Companion Ticket"
79
+ | "Discount Companion Ticket"
80
+ | "Global Entry or TSA PreCheck"
81
+ | "Private Jet Perks"
82
+ | "Lounge Access Discount"
83
+ | "24/7 Cardholder Support"
84
+ | "Authorized User"
85
+ | "Entertainment Access"
86
+ | "Airline Fee Credit"
87
+ | "Late Fee Pass"
88
+ | "Credit Score Reporting"
89
+ | "No Flight Change Fees"
90
+ | "24/7 Account Monitoring"
91
+ | "Amex Offers"
92
+ | "Visa Signature Offers"
93
+ | "MasterCard Offers"
94
+ | "Free Hotel Stay"
95
+ | "Extended Hotel Stay"
96
+ | "Dining Concierge"
97
+ | "2 Lounge Passes"
98
+ | "Hilton Honors Silver Membership"
99
+ | "Hilton Honors Gold Membership"
100
+ | "World of Hyatt Discoverist Status"
101
+ | "SPG Gold Membership"
102
+ | "Marriott Rewards Silver Status"
103
+ | "Hertz Presidents Circle Elite Status"
104
+ | "2 Free Checked Bags"
105
+ | "Auto Discounts"
106
+ | "InCircle Partnership"
107
+ | "ShopRunner"
108
+ | "WiFi Access"
109
+ | "ShopSafe"
110
+ | "BoA Preferred Rewards"
111
+ | "MasterCard Fuel Rewards Network"
112
+ | "Missed Event Ticket Protection"
113
+ | "Account Freezing"
114
+ | "Cell Phone Protection"
115
+ | "GPA Rewards"
116
+ | "In-Flight WiFi Credit"
117
+ | "Citi Private Pass"
118
+ | "Priceless Cities"
119
+ | "The Hotel Collection"
120
+ | "By Invitation Only"
121
+ | "Luxury Hotel Collection"
122
+ | "Expedia+ Silver Status"
123
+ | "Expedia+ Gold Status"
124
+ | "$100 American Airlines Discount"
125
+ | "Disney Parks Perks and Savings"
126
+ | "Ritz-Carlton Gold Elite Status"
127
+ | "Ritz-Carlton Club Level Upgrade"
128
+ | "Annual Travel Credit"
129
+ | "IHG Platinum Elite Status"
130
+ | "QuickBooks Connect"
131
+ | "ReceiptMatch"
132
+ | "Employee Spending Limits"
133
+ | "FX International Payments"
134
+ | "No Pre-Set Spending Limit"
135
+ | "Purchase Financing"
136
+ | "Amex Open Savings"
137
+ | "Amazon Special Financing"
138
+ | "$100 Ritz-Carlton Hotel Credit"
139
+ | "British Airways Companion Ticket"
140
+ | "Mercedes-Benz Gift Certificates"
141
+ | "Mercedes-Benz Excess Mileage Waiver"
142
+ | "JetBlue Annual Statement Credit"
143
+ | "20% Discount on Delta Flights for Delta Private Jet Members"
144
+ | "Expense Report Features"
145
+ | "Business Cell Phone Protection"
146
+ | "Free Shipping on most Target.com orders"
147
+ | "30 Extra Days for Returns"
148
+ | "Free clothing altertaions"
149
+ | "Personal shopping"
150
+ | "Shopmyway Savings"
151
+ | "Online Subscription Credit"
152
+ | "Uber Exclusive Access"
153
+ | "Airline Benefits"
154
+ | "Hotel Benefits"
155
+ | "Other Travel Benefits"
156
+ | "Emergency Assistance"
157
+ | "Experiences"
158
+ | "Shopping Benefits"
159
+ | "Cardholder Benefits"
160
+ | "Enhanced Security"
161
+ | "Business Benefits"
162
+ | "Other Benefits"
163
+ | "In-Flight Discounts"
164
+ | "Fee Coverage"
165
+ | "Flight Credits & Discounts"
166
+ | "Hotel Membership Status"
167
+ | "Hotel Credit & Free Stays"
168
+ | "Travel Credit"
169
+ | "Travel Experiences Programs"
170
+ | "Car Rental Membership Status"
171
+ | "Extra Gas Rewards"
172
+ | "Shopping Protection"
173
+ | "Shopping Discounts"
174
+ | "Free Shipping"
175
+ | "The Boingo American Express Preferred Plan"
176
+ | "AirSpace Lounge"
177
+ | "Uber Monthly Credit"
178
+ | "Ride Share Benefits"
179
+ | "Delta Sky Club"
180
+ | "Admirals Club Membership"
181
+ | "Priority Pass Select Membership (Prestige)"
182
+ | "Priority Pass Select Membership (Standard Plus)"
183
+ | "Daily Breakfast"
184
+ | "Early Check-in & Late Check-out"
185
+ | "Room Upgrades"
186
+ | "Complementary WiFi"
187
+ | "Amex Hotel Collection Credit"
188
+ | "Temporary Account Numbers"
189
+ | "One-Time 50% Discount on Companion Ticket"
190
+ | "Airline Travel Credit"
191
+ | "United Club Membership"
192
+ | "Chip Technology"
193
+ | "Earn More Miles for Sharing Travel Stories"
194
+ | "Mastercard World Elite Concierge and Luxury Travel Benefits"
195
+ | "20% Savings on Delta In-Flight Purchases"
196
+ | "25% Savings on United In-Flight Food and Drink Purchases"
197
+ | "$100 Hilton Properties Credit"
198
+ | "$250 Hilton Resort Credit"
199
+ | "Hilton Honors Diamond Membership"
200
+ | "Free Birthday Gift"
201
+ | "2x Points During Your Birthday Month"
202
+ | "Car Rental VIP Perks"
203
+ | "Free shipping with the purchase of a bra"
204
+ | "Monthly Dining Credit"
205
+ | "Amazon Prime Student";
206
+ /**
207
+ * @description Purposes or categories related to a credit card
208
+ * @enum {string}
209
+ */
210
+ CardPurpose:
211
+ | "balance_transfer"
212
+ | "cash_back"
213
+ | "earning_rewards"
214
+ | "improve_credit"
215
+ | "low_interest"
216
+ | "new_to_credit"
217
+ | "student"
218
+ | "travel_incentives";
219
+ /** @enum {string} */
220
+ CardType: "visa" | "mastercard" | "american_express" | "discover";
221
+ /**
222
+ * @description Carrier decision speed
223
+ * @enum {string}
224
+ */
225
+ CarrierDecisionType: "instant" | "non_instant";
226
+ /**
227
+ * @description Citizenship status
228
+ * @enum {string}
229
+ */
230
+ CitizenshipStatus: "citizen" | "permanent_resident" | "other";
231
+ /** @enum {string} */
232
+ CompoundingMethod:
233
+ | "annually"
234
+ | "continuous"
235
+ | "daily"
236
+ | "monthly"
237
+ | "quarterly"
238
+ | "semiAnnually"
239
+ | "simple"
240
+ | "weekly";
241
+ /** @description An offer for a credit card */
242
+ CreditCardOffer: WithRequired<
243
+ {
244
+ details: components["schemas"]["CreditCardOfferDetails"];
245
+ } & components["schemas"]["Offer"],
246
+ "details"
247
+ >;
248
+ CreditCardOfferDetails: {
249
+ /** @description Display name of the card */
250
+ cardName?: string;
251
+ /** Format: url */
252
+ cardImageUrl: string;
253
+ cardPurposes?: components["schemas"]["CardPurpose"][];
254
+ /**
255
+ * Format: url
256
+ * @description External link to card rates, terms and conditions
257
+ */
258
+ ratesUrl?: string;
259
+ maxPurchaseApr?: number;
260
+ minPurchaseApr?: number;
261
+ purchaseAprText?: string;
262
+ maxPurchaseIntroApr?: number;
263
+ minPurchaseIntroApr?: number;
264
+ /** Format: int32 */
265
+ purchaseIntroAprTerm?: number;
266
+ purchaseIntroAprTermUnit?: components["schemas"]["TermUnit"];
267
+ purchaseIntroAprText?: string;
268
+ maxCashAdvanceApr?: number;
269
+ minCashAdvanceApr?: number;
270
+ cashAdvanceAprText?: string;
271
+ maxCashAdvanceIntroApr?: number;
272
+ minCashAdvanceIntroApr?: number;
273
+ /** Format: int32 */
274
+ cashAdvanceIntroAprTerm?: number;
275
+ cashAdvanceIntroAprTermUnit?: components["schemas"]["TermUnit"];
276
+ cashAdvanceIntroAprText?: string;
277
+ maxBalanceTransferApr?: number;
278
+ minBalanceTransferApr?: number;
279
+ balanceTransferAprText?: string;
280
+ maxBalanceTransferIntroApr?: number;
281
+ minBalanceTransferIntroApr?: number;
282
+ /** Format: int32 */
283
+ balanceTransferIntroAprTerm?: number;
284
+ balanceTransferIntroAprTermUnit?: components["schemas"]["TermUnit"];
285
+ balanceTransferIntroAprText?: string;
286
+ maxAnnualFee?: number;
287
+ minAnnualFee?: number;
288
+ annualIntroFee?: number;
289
+ /**
290
+ * Format: int32
291
+ * @description Number of _years_ the introductory anual fee is in effect
292
+ */
293
+ annualIntroFeeTerm?: number;
294
+ introOfferAmount?: number;
295
+ introOfferText?: string;
296
+ introOfferType?: components["schemas"]["IntroOfferType"];
297
+ /** @description List of card features which must be prominently displayed with the offer */
298
+ details?: string[];
299
+ /** @description List of card features which must be displayed with the offer */
300
+ additionalDetails?: string[];
301
+ cardType: components["schemas"]["CardType"];
302
+ minimumCreditLine?: number;
303
+ minimumPenaltyApr?: number;
304
+ maximumPenaltyApr?: number;
305
+ balanceTransferFee?: number;
306
+ cashAdvanceFee?: number;
307
+ lateFee?: number;
308
+ foreignExchangeFee?: number;
309
+ accountOpeningFee?: number;
310
+ returnPaymentFee?: number;
311
+ monthlyServiceFee?: number;
312
+ recommendedCreditRatings?: components["schemas"]["ProvidedCreditRating"][];
313
+ preQualified: boolean;
314
+ preApproved: boolean;
315
+ /** @description Indicates that Engine by MoneyLion has determined that the user has an increased likelihood of being approved for this card. */
316
+ preSelected: boolean;
317
+ /**
318
+ * Format: double
319
+ * @description Percentage represented in decimal format added to all foreign transactions
320
+ */
321
+ foreignTransactionFee?: number;
322
+ cardBenefits?: components["schemas"]["CardBenefit"][];
323
+ };
324
+ /**
325
+ * @description Arbitrary key-values mappings to associate with a `Lead`. This field can be use to attach `subid`s to a `Lead`
326
+ * @example {
327
+ * "subid": [
328
+ * "123"
329
+ * ]
330
+ * }
331
+ */
332
+ ClientTags: {
333
+ [key: string]: string[];
334
+ };
335
+ /** conversion */
336
+ ConversionEventData: {
337
+ /**
338
+ * Format: int32
339
+ * @description The number of cents paid out for the conversion event.
340
+ */
341
+ payoutInCents?: number;
342
+ /** @description The product type of the converted offer. */
343
+ productType?: components["schemas"]["ProductType"];
344
+ };
345
+ /** @enum {string} */
346
+ EducationLevel:
347
+ | "high_school"
348
+ | "associate"
349
+ | "bachelors"
350
+ | "masters"
351
+ | "doctorate"
352
+ | "other_grad_degree"
353
+ | "certificate"
354
+ | "did_not_graduate"
355
+ | "still_enrolled"
356
+ | "other";
357
+ /** @enum {string} */
358
+ EmploymentPayFrequency: "weekly" | "biweekly" | "twice_monthly" | "monthly";
359
+ /** @enum {string} */
360
+ EmploymentStatus:
361
+ | "employed"
362
+ | "employed_full_time"
363
+ | "employed_part_time"
364
+ | "military"
365
+ | "not_employed"
366
+ | "self_employed"
367
+ | "retired"
368
+ | "other";
369
+ EventData:
370
+ | components["schemas"]["ApiApprovedEventData"]
371
+ | components["schemas"]["ApiRejectedEventData"]
372
+ | components["schemas"]["AppliedEventData"]
373
+ | components["schemas"]["ApprovedEventData"]
374
+ | components["schemas"]["ConversionEventData"]
375
+ | components["schemas"]["FundedEventData"]
376
+ | components["schemas"]["ListedEventData"]
377
+ | components["schemas"]["OfferClickedEventData"]
378
+ | components["schemas"]["OpenedEventData"];
379
+ /** @enum {string} */
380
+ EventType:
381
+ | "leadCreated"
382
+ | "appSubmitted"
383
+ | "apiApproved"
384
+ | "apiRejected"
385
+ | "offerClicked"
386
+ | "lenderQualifiedLead"
387
+ | "applied"
388
+ | "approved"
389
+ | "listed"
390
+ | "opened"
391
+ | "funded"
392
+ | "conversion";
393
+ FeaturedFinancialInstitution: {
394
+ /**
395
+ * Format: uuid
396
+ * @description A unique identifier for the financial institution.
397
+ */
398
+ uuid: string;
399
+ /**
400
+ * @description The name of the financial institution. This value is subject to
401
+ * change, so `financialInstitutionUuid` should be used for grouping.
402
+ */
403
+ name: string;
404
+ /**
405
+ * Format: url
406
+ * @description The URL of an image logo for the associated financial institution.
407
+ */
408
+ logoUrl: string;
409
+ };
410
+ /** @enum {string} */
411
+ FederalInsuranceType: "fdic" | "ncua";
412
+ FinancialInstitutionLoanReport: {
413
+ /**
414
+ * Format: uuid
415
+ * @description The unique identifier for the financial institution.
416
+ */
417
+ uuid: string;
418
+ /** @description The name of the financial institution. */
419
+ name: string;
420
+ /** @description A URL of a logo for the financial institution. */
421
+ logoUrl?: string;
422
+ /** @description The approval probabilities for the financial intitution. */
423
+ probabilities: components["schemas"]["LoanProbability"][];
424
+ };
425
+ /** funded */
426
+ FundedEventData: {
427
+ /**
428
+ * Format: int32
429
+ * @description The dollar amount of the offer that was funded.
430
+ */
431
+ amount?: number;
432
+ /** @description The product type of the funded offer. */
433
+ productType?: components["schemas"]["ProductType"];
434
+ };
435
+ /** @enum {string} */
436
+ IdType: "driver_license" | "state_id" | "passport";
437
+ IncentiveDetails: {
438
+ /** Format: double */
439
+ amount: number;
440
+ unit: components["schemas"]["IncentiveUnit"];
441
+ display: string;
442
+ type: components["schemas"]["IncentiveType"];
443
+ };
444
+ /**
445
+ * @description Unit of measure for incentives.
446
+ *
447
+ * @enum {string}
448
+ */
449
+ IncentiveType: "cash_back" | "other";
450
+ /**
451
+ * @description Unit of measure for incentives.
452
+ *
453
+ * @enum {string}
454
+ */
455
+ IncentiveUnit: "usd" | "other";
456
+ /** @enum {string} */
457
+ GraduateDegreeType:
458
+ | "doctor_of_medicine"
459
+ | "doctor_of_osteopathic_medicine"
460
+ | "doctor_of_optometry"
461
+ | "doctor_of_dental_medicine"
462
+ | "dentariae_medicinae_doctoris"
463
+ | "doctor_of_dental_surgery"
464
+ | "doctor_of_veterinary_medicine"
465
+ | "doctor_of_pharmacy"
466
+ | "veterinariae_medicinae_doctoris"
467
+ | "master_of_arts"
468
+ | "master_of_science"
469
+ | "master_of_research"
470
+ | "master_of_research_project"
471
+ | "master_of_studies"
472
+ | "master_of_business_administration"
473
+ | "master_of_library_science"
474
+ | "master_of_public_administration"
475
+ | "master_of_public_health"
476
+ | "master_of_laws"
477
+ | "master_of_arts_liberal_studies"
478
+ | "master_of_fine_arts"
479
+ | "master_of_music"
480
+ | "master_of_education"
481
+ | "master_of_engineering"
482
+ | "master_of_architecture"
483
+ | "juris_doctor"
484
+ | "other";
485
+ /** @enum {string} */
486
+ Gender: "male" | "female";
487
+ /** @enum {string} */
488
+ IntroOfferType: "miles" | "points" | "statement_credit";
489
+ Lead: {
490
+ /** @description Name of company which provided the lead */
491
+ leadProviderName: string;
492
+ personalInformation?: components["schemas"]["LeadPersonalInformation"];
493
+ personalReferenceInformation?: components["schemas"]["PersonalReferenceInformation"];
494
+ loanInformation?: components["schemas"]["LeadLoanInformation"];
495
+ mortgageInformation?: components["schemas"]["LeadMortgageInformation"];
496
+ creditCardInformation?: components["schemas"]["LeadCreditCardInformation"];
497
+ savingsInformation?: components["schemas"]["LeadSavingsInformation"];
498
+ creditInformation?: components["schemas"]["LeadCreditInformation"];
499
+ financialInformation?: components["schemas"]["LeadFinancialInformation"];
500
+ employmentInformation?: components["schemas"]["LeadEmploymentInformation"];
501
+ legalInformation?: components["schemas"]["LeadLegalInformation"];
502
+ educationInformation?: components["schemas"]["LeadEducationInformation"];
503
+ coApplicantInformation?: components["schemas"]["LeadCoApplicantInformation"];
504
+ healthInformation?: components["schemas"]["LeadHealthInformation"];
505
+ identificationInformation?: components["schemas"]["LeadIdentificationInformation"];
506
+ refinanceLoans?: components["schemas"]["RefinanceLoanInformation"][];
507
+ clientTags?: components["schemas"]["ClientTags"];
508
+ sessionInformation?: components["schemas"]["LeadSessionInformation"];
509
+ leadActions?: components["schemas"]["LeadAction"][];
510
+ /**
511
+ * Format: uuid
512
+ * @description Primary UUID for a `Lead`
513
+ */
514
+ uuid: string;
515
+ /**
516
+ * Format: uuid
517
+ * @description UUID for a company which created the `Lead`
518
+ */
519
+ companyUUID: string;
520
+ /**
521
+ * Format: uuid
522
+ * @description UUID used to link leads across verticals, unique per user per supply sub-account
523
+ */
524
+ sessionUuid?: string;
525
+ /**
526
+ * Format: uuid
527
+ * @description Unique identifier for the lead's device.
528
+ */
529
+ deviceId?: string;
530
+ /**
531
+ * Format: uuid
532
+ * @deprecated
533
+ */
534
+ referralCompanyUuid?: string;
535
+ /** Format: uuid */
536
+ trackingUuid?: string;
537
+ /** @description Whether a `Lead` was created using a test access token */
538
+ isTest: boolean;
539
+ /** @description The furthest step of the funnel a `Lead` has reached */
540
+ status: components["schemas"]["LeadActionType"];
541
+ createdAt: string;
542
+ updatedAt: string;
543
+ };
544
+ /** @enum {string} */
545
+ LeadBestTimeToCall: "morning" | "afternoon" | "evening" | "night";
546
+ /**
547
+ * @description The personal information of a co-applicant that may be considered in the
548
+ * underwriting and approval of a loan.
549
+ */
550
+ LeadCoApplicantInformation: {
551
+ firstName?: string;
552
+ lastName?: string;
553
+ /** Format: date */
554
+ dateOfBirth?: string;
555
+ /** Format: int32 */
556
+ annualIncome?: number;
557
+ /** @description Street address (primary address line) */
558
+ streetAddress1?: string;
559
+ /** @description Secondary address line */
560
+ streetAddress2?: string;
561
+ city?: string;
562
+ state?: components["schemas"]["State"];
563
+ zipcode?: string;
564
+ };
565
+ /** @description Credit history information relating to a `Lead` */
566
+ LeadCreditInformation: {
567
+ providedCreditRating?: components["schemas"]["ProvidedCreditRating"];
568
+ /**
569
+ * Format: int32
570
+ * @description FICO credit score provided by a `Lead`
571
+ */
572
+ providedNumericCreditScore?: number;
573
+ };
574
+ LeadCreditCardInformation: {
575
+ allowAnnualFee?: boolean;
576
+ /** @description A list of card purposes in which the lead is interested */
577
+ cardPurposes?: components["schemas"]["CardPurpose"][];
578
+ };
579
+ LeadClientTagsResponse: {
580
+ /** @description A URL which identifies where the next batch of LeadClientTags can be queried for. */
581
+ nextUrl: string;
582
+ /**
583
+ * @description If true, data is currently available at `nextUrl`.
584
+ * Calling the `nextUrl` at the current time will return the next batch of data.
585
+ * If false, calling `nextUrl` at the current time will return an error response from the API.
586
+ * Data will be made available at a later time (at the next hour mark).
587
+ */
588
+ shouldContinuePolling: boolean;
589
+ /** @description Lead client tag data for the requested time window. */
590
+ data: components["schemas"]["LeadClientTag"][];
591
+ };
592
+ LeadClientTag: {
593
+ /** @description A unique hash for the client tag to assist with deduplication. */
594
+ hash: string;
595
+ /**
596
+ * Format: uuid
597
+ * @description The UUID of the lead that this client tag belongs to.
598
+ */
599
+ leadUuid: string;
600
+ /** @description The key of this client tag. */
601
+ key: string;
602
+ /** @description The latest value for the client tag key. */
603
+ value: string;
604
+ /**
605
+ * Format: date-time
606
+ * @description The time that this client tag was added to the lead.
607
+ */
608
+ createdAt: string;
609
+ };
610
+ /**
611
+ * @example {
612
+ * "summary": "A lead request",
613
+ * "value": {
614
+ * "productTypes": [
615
+ * "loan",
616
+ * "savings"
617
+ * ],
618
+ * "personalInformation": {
619
+ * "firstName": "John",
620
+ * "lastName": "Doe",
621
+ * "email": "john@example.com",
622
+ * "city": "New York",
623
+ * "state": "NY",
624
+ * "workPhone": "2125551234",
625
+ * "primaryPhone": "2125556789",
626
+ * "address1": "45 West 21st Street",
627
+ * "address2": "5th Floor",
628
+ * "zipcode": "10010",
629
+ * "monthsAtAddress": 5,
630
+ * "driversLicenseNumber": "111222333",
631
+ * "driversLicenseState": "NY",
632
+ * "ipAddress": "8.8.8.8",
633
+ * "activeMilitary": false,
634
+ * "militaryVeteran": true,
635
+ * "dateOfBirth": "1993-10-09",
636
+ * "ssn": "111-22-3333"
637
+ * },
638
+ * "loanInformation": {
639
+ * "purpose": "debt_consolidation",
640
+ * "loanAmount": 10000
641
+ * },
642
+ * "mortgageInformation": {
643
+ * "propertyType": "condo",
644
+ * "propertyStatus": "own_with_mortgage",
645
+ * "propertyValue": 200000,
646
+ * "mortgageBalance": 10000,
647
+ * "lenderName": "Bank OF NY",
648
+ * "hasFHALoan": true,
649
+ * "currentWithLoan": true
650
+ * },
651
+ * "creditCardInformation": {
652
+ * "allowAnnualFee": true,
653
+ * "cardPurposes": [
654
+ * "travel_incentives"
655
+ * ]
656
+ * },
657
+ * "savingsInformation": {
658
+ * "minDepositAmount": 1000
659
+ * },
660
+ * "creditInformation": {
661
+ * "providedCreditRating": "excellent",
662
+ * "providedNumericCreditScore": 750
663
+ * },
664
+ * "financialInformation": {
665
+ * "creditCardDebt": 5000,
666
+ * "employmentStatus": "employed",
667
+ * "employmentPayFrequency": "weekly",
668
+ * "annualIncome": 120000,
669
+ * "monthlyNetIncome": 10000,
670
+ * "bankName": "Santander",
671
+ * "bankRoutingNumber": "231372691",
672
+ * "bankAccountType": "savings",
673
+ * "monthsAtBank": 10,
674
+ * "bankAccountNumber": "1234567890"
675
+ * },
676
+ * "employmentInformation": {
677
+ * "employerName": "Engine by MoneyLion",
678
+ * "employerAddress": "45 W 21st St",
679
+ * "employerCity": "New York",
680
+ * "employerState": "NY",
681
+ * "employerZip": "10010",
682
+ * "jobTitle": "Software Engineer",
683
+ * "monthsEmployed": 14,
684
+ * "directDeposit": true,
685
+ * "payDate1": "2004-10-06",
686
+ * "payDate2": "2004-11-06"
687
+ * },
688
+ * "educationInformation": {
689
+ * "educationLevel": "masters",
690
+ * "graduateDegreeType": "master_of_science",
691
+ * "universityAttended": "Johns Hopkins University"
692
+ * },
693
+ * "coApplicantInformation": {
694
+ * "firstName": "Jane",
695
+ * "lastName": "Doe",
696
+ * "dateOfBirth": "1984-03-06",
697
+ * "annualIncome": 100000,
698
+ * "streetAddress1": "45 West 21st Street",
699
+ * "streetAddress2": "5th Floor",
700
+ * "city": "New York",
701
+ * "state": "NY",
702
+ * "zipcode": "10010"
703
+ * },
704
+ * "healthInformation": {
705
+ * "gender": "male",
706
+ * "heightInInches": 72,
707
+ * "weightInPounds": 195,
708
+ * "tobaccoSmoker": false
709
+ * },
710
+ * "legalInformation": {
711
+ * "consentsToFcra": true,
712
+ * "consentsToTcpa": true,
713
+ * "fcraLanguage": "By checking this box/clicking 'agree' I hereby consent to the 'E-Sign Agreement', the 'Credit Authorization Agreement', the Terms of Service and Privacy Policy, and I am providing written consent under the Fair Credit Reporting Act (FCRA) for [Engine by MoneyLion and/or Insert Company Name], its partners and financial institutions to obtain consumer report information from my credit profile. I request that my information be provided to their partners, lenders, and financial services partners to provide me with financial recommendations, which may also include debt relief, credit repair, credit monitoring or other related services",
714
+ * "tcpaLanguage": "I agree to be contacted by [Engine by MoneyLion and/or Insert Company Name] its partners and their affiliated companies and financial institutions via email, postal mail service and/or at the telephone number(s) I have provided above to explore various financial products and services I inquired about, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. Consent is not required as a condition to utilize the service, and you may choose to be contacted by an individual customer care representative(s) by calling XXXXX or emailing XXXX"
715
+ * },
716
+ * "clientTags": {
717
+ * "hello": [
718
+ * "world",
719
+ * "there"
720
+ * ],
721
+ * "something": [
722
+ * "else"
723
+ * ]
724
+ * }
725
+ * }
726
+ * }
727
+ */
728
+ LeadCreateData: {
729
+ /** @description Product types in which the `Lead` is interested */
730
+ productTypes?: components["schemas"]["ProductType"][];
731
+ /**
732
+ * Format: uuid
733
+ * @description Primary UUID for a `Lead`
734
+ */
735
+ uuid?: string;
736
+ /**
737
+ * Format: uuid
738
+ * @description UUID used to link leads across verticals, unique per user per supply sub-account
739
+ */
740
+ sessionUuid?: string;
741
+ /**
742
+ * Format: uuid
743
+ * @description Unique identifier for the lead's device.
744
+ */
745
+ deviceId?: string;
746
+ loanInformation?: components["schemas"]["LeadLoanInformation"];
747
+ personalInformation?: components["schemas"]["LeadPersonalInformation"];
748
+ personalReferenceInformation?: components["schemas"]["PersonalReferenceInformation"];
749
+ mortgageInformation?: components["schemas"]["LeadMortgageInformation"];
750
+ creditCardInformation?: components["schemas"]["LeadCreditCardInformation"];
751
+ savingsInformation?: components["schemas"]["LeadSavingsInformation"];
752
+ creditInformation?: components["schemas"]["LeadCreditInformation"];
753
+ financialInformation?: components["schemas"]["LeadFinancialInformation"];
754
+ employmentInformation?: components["schemas"]["LeadEmploymentInformation"];
755
+ legalInformation?: components["schemas"]["LeadLegalInformation"];
756
+ educationInformation?: components["schemas"]["LeadEducationInformation"];
757
+ coApplicantInformation?: components["schemas"]["LeadCoApplicantInformation"];
758
+ healthInformation?: components["schemas"]["LeadHealthInformation"];
759
+ /** @description One or more loans that the lead wishes to refinance or consolidate */
760
+ refinanceLoans?: components["schemas"]["RefinanceLoanInformation"][];
761
+ identificationInformation?: components["schemas"]["LeadIdentificationInformation"];
762
+ clientTags?: components["schemas"]["ClientTags"];
763
+ sessionInformation?: components["schemas"]["LeadSessionInformation"];
764
+ /**
765
+ * @deprecated
766
+ * @description Whether the `Lead` has completed an application form
767
+ */
768
+ formCompleted?: boolean;
769
+ /**
770
+ * Format: uuid
771
+ * @deprecated
772
+ * @description UUID of company from which the `Lead` was referred
773
+ */
774
+ referralCompanyUuid?: string;
775
+ /**
776
+ * Format: uuid
777
+ * @deprecated
778
+ * @description UUID for internal Engine by MoneyLion tracking purposes. This field should never be set by 3rd party API consumers
779
+ */
780
+ trackingUuid?: string;
781
+ };
782
+ LeadEducationInformation: {
783
+ educationLevel?: components["schemas"]["EducationLevel"];
784
+ graduateDegreeType?: components["schemas"]["GraduateDegreeType"];
785
+ /**
786
+ * @deprecated
787
+ * @description Name of university where a lead received their undergraduate degree.
788
+ * A lookup service for possible universities is available from using the /leads/universities endpoint.
789
+ * To maximize returned offers, this string must match one of the names returned from the lookup.
790
+ */
791
+ universityAttended?: string;
792
+ universityOpeId?: components["schemas"]["OpeId"];
793
+ /**
794
+ * Format: date
795
+ * @deprecated
796
+ * @description Date the lead graudated from undergrad (YYYY-MM-DD)
797
+ */
798
+ graduationDate?: string;
799
+ /**
800
+ * Format: date
801
+ * @description Lead's graduate school graduation date (YYYY-MM-DD)
802
+ */
803
+ graduateGraduationDate?: string;
804
+ /**
805
+ * Format: date
806
+ * @description Lead's last attended month/year for graduate school (YYYY-MM-DD)
807
+ */
808
+ graduateLastAttendedDate?: string;
809
+ /**
810
+ * @description Name of university where a lead received their graduate degree.
811
+ * A lookup service for possible universities is available from using the /leads/universities endpoint.
812
+ * To maximize returned offers, this string must match one of the names returned from the lookup.
813
+ */
814
+ graduateUniversityAttended?: string;
815
+ graduateUniversityOpeId?: components["schemas"]["OpeId"];
816
+ /**
817
+ * Format: date
818
+ * @description Date the lead graduated from undergrad (YYYY-MM-DD).
819
+ */
820
+ undergraduateGraduationDate?: string;
821
+ /**
822
+ * Format: date
823
+ * @description Lead's last attended month/year for undergrad (YYYY-MM-DD)
824
+ */
825
+ undergraduateLastAttendedDate?: string;
826
+ /**
827
+ * @description Name of university where a lead received their undergraduate degree.
828
+ * A lookup service for possible universities is available from using the /leads/universities endpoint.
829
+ * To maximize returned offers, this string must match one of the names returned from the lookup.
830
+ */
831
+ undergraduateUniversityAttended?: string;
832
+ undergraduateUniversityOpeId?: components["schemas"]["OpeId"];
833
+ };
834
+ LeadEducationLevel: components["schemas"]["EducationLevel"];
835
+ LeadEmploymentInformation: {
836
+ employerName?: string;
837
+ employerAddress?: string;
838
+ employerAddress2?: string;
839
+ employerCity?: string;
840
+ employerPhone?: string;
841
+ employerState?: string;
842
+ employerZip?: string;
843
+ jobTitle?: string;
844
+ /** Format: int32 */
845
+ monthsEmployed?: number;
846
+ /** @description Whether a `Lead` uses direct deposit for their salary */
847
+ directDeposit?: boolean;
848
+ /** Format: date */
849
+ payDate1?: string;
850
+ /** Format: date */
851
+ payDate2?: string;
852
+ /**
853
+ * Format: date
854
+ * @description The date the lead started working at their current employer (YYYY-MM-DD)
855
+ */
856
+ startDate?: string;
857
+ };
858
+ LeadFinancialInformation: {
859
+ employmentStatus?: components["schemas"]["EmploymentStatus"];
860
+ employmentPayFrequency?: components["schemas"]["EmploymentPayFrequency"];
861
+ /** Format: int32 */
862
+ annualIncome?: number;
863
+ /** Format: int32 */
864
+ monthlyNetIncome?: number;
865
+ bankName?: string;
866
+ bankRoutingNumber?: string;
867
+ bankAccountType?: components["schemas"]["BankAccountType"];
868
+ /** Format: int32 */
869
+ creditCardDebt?: number;
870
+ /** Format: int32 */
871
+ monthsAtBank?: number;
872
+ bankAccountNumber?: string;
873
+ /** Format: int32 */
874
+ monthlyDebt?: number;
875
+ /** Format: int32 */
876
+ totalAssets?: number;
877
+ /** Format: int32 */
878
+ monthlyHousingPayment?: number;
879
+ /** Format: int32 */
880
+ availableAssets?: number;
881
+ /**
882
+ * Format: int32
883
+ * @description The amount of additional income the lead recieves
884
+ */
885
+ additionalIncome?: number;
886
+ /** @description The frequency the lead recieves additional income */
887
+ additionalIncomeFrequency?: components["schemas"]["EmploymentPayFrequency"];
888
+ /** @description Do you have a direct deposit? */
889
+ hasDirectDeposit?: boolean;
890
+ /**
891
+ * Format: int32
892
+ * @description Approximate total unsecured debt in dollars
893
+ */
894
+ totalUnsecuredDebt?: number;
895
+ };
896
+ LeadHealthInformation: {
897
+ gender?: components["schemas"]["Gender"];
898
+ /** Format: int32 */
899
+ heightInInches?: number;
900
+ /** Format: int32 */
901
+ weightInPounds?: number;
902
+ tobaccoSmoker?: boolean;
903
+ };
904
+ LeadIdentificationInformation: {
905
+ /** @description The ID number supplied by the lead */
906
+ idNumber?: string;
907
+ /** @description The state of issue of the supplied ID */
908
+ idState?: string;
909
+ /** @description The form of the ID number supplied by the lead */
910
+ idType?: components["schemas"]["IdType"];
911
+ };
912
+ /** @description Information regarding a `Lead`'s communication concent */
913
+ LeadLegalInformation: {
914
+ /** @description Whether the lead was shown, and consented to a Fair Credit Reporting Act notice */
915
+ consentsToFcra?: boolean;
916
+ /** @description The lead agrees to recieve SMS text messages from the Financial Institution */
917
+ consentsToSms?: boolean;
918
+ /** @description Whether the lead was shown, and consented to a Telephone Consumer Protection Act notice */
919
+ consentsToTcpa?: boolean;
920
+ /** @description The exact FCRA language to which the lead consented */
921
+ fcraLanguage?: string;
922
+ /** @description The exact TCPA language to which the lead consented */
923
+ tcpaLanguage?: string;
924
+ };
925
+ LeadLoanInformation: {
926
+ purpose?: components["schemas"]["LoanPurpose"];
927
+ /** Format: int32 */
928
+ loanAmount?: number;
929
+ };
930
+ LeadMortgageInformation: {
931
+ propertyType?: components["schemas"]["PropertyType"];
932
+ /** Format: int32 */
933
+ propertyValue?: number;
934
+ /** Format: int32 */
935
+ mortgageBalance?: number;
936
+ lenderName?: string;
937
+ hasFHALoan?: boolean;
938
+ currentWithLoan?: boolean;
939
+ propertyStatus?: components["schemas"]["PropertyStatus"];
940
+ mortgageType?: components["schemas"]["MortgageType"];
941
+ /**
942
+ * Format: int32
943
+ * @description Amount the lead will borrow
944
+ */
945
+ mortgageAmount?: number;
946
+ /** Format: int32 */
947
+ downPaymentAmount?: number;
948
+ propertyState?: string;
949
+ propertyCounty?: string;
950
+ /** @description Street address (primary address line) */
951
+ propertyAddress1?: string;
952
+ /** @description Secondary address line */
953
+ propertyAddress2?: string;
954
+ propertyZipcode?: string;
955
+ propertyCity?: string;
956
+ /**
957
+ * Format: int32
958
+ * @description Amount the lead will borrow for refinancing an existing mortgage
959
+ */
960
+ refinanceAmount?: number;
961
+ /**
962
+ * Format: int32
963
+ * @description Additional amount the lead will borrow against existing home equity in the case of refinance
964
+ */
965
+ cashOutAmount?: number;
966
+ occupancyType?: components["schemas"]["OccupancyType"];
967
+ refinanceType?: components["schemas"]["RefinanceType"];
968
+ propertySearchStatus?: components["schemas"]["PropertySearchStatus"];
969
+ /**
970
+ * Format: int32
971
+ * @description The number of legal units on the property
972
+ */
973
+ numUnits?: number;
974
+ /** Format: date */
975
+ closingDate?: string;
976
+ purchaseStatus?: components["schemas"]["PurchaseStatus"];
977
+ /** Format: date */
978
+ purchaseDate?: string;
979
+ /**
980
+ * Format: float
981
+ * @description The amount of the HOA fee for the lead
982
+ */
983
+ monthlyHoaFee?: number;
984
+ /** @description The name of the company holding the lead's mortgage */
985
+ mortgageCompany?: string;
986
+ /**
987
+ * Format: float
988
+ * @description The amount of escrow the lead pays
989
+ */
990
+ mortgageEscrowAmount?: number;
991
+ };
992
+ LeadPersonalInformation: {
993
+ firstName?: string;
994
+ lastName?: string;
995
+ /** @description The first name the lead uses as an alias */
996
+ aliasFirstName?: string;
997
+ /** @description The last name the lead uses as an alias */
998
+ aliasLastName?: string;
999
+ /** Format: email */
1000
+ email?: string;
1001
+ city?: string;
1002
+ state?: components["schemas"]["State"];
1003
+ workPhone?: string;
1004
+ primaryPhone?: string;
1005
+ bestTimeToCall?: components["schemas"]["LeadBestTimeToCall"];
1006
+ /** @description Street address (primary address line) */
1007
+ address1?: string;
1008
+ /** @description Secondary address line */
1009
+ address2?: string;
1010
+ /**
1011
+ * Format: date
1012
+ * @description The date the lead moved into their current address
1013
+ */
1014
+ addressMoveInDate?: string;
1015
+ zipcode?: string;
1016
+ /**
1017
+ * Format: int32
1018
+ * @description Number of months the provided address has been the lead's primary residence
1019
+ */
1020
+ monthsAtAddress?: number;
1021
+ driversLicenseNumber?: string;
1022
+ /** @description State in which the driver's license was issued */
1023
+ driversLicenseState?: string;
1024
+ /**
1025
+ * Format: ip
1026
+ * @description IP address
1027
+ */
1028
+ ipAddress?: string;
1029
+ /** @description Whether the lead is currently in the military (not a veteran) */
1030
+ activeMilitary?: boolean;
1031
+ /** @description Whether the lead is a veteran (should not be used if the lead is active in the military) */
1032
+ militaryVeteran?: boolean;
1033
+ /** Format: date */
1034
+ dateOfBirth?: string;
1035
+ /** @deprecated */
1036
+ educationLevel?: components["schemas"]["EducationLevel"];
1037
+ ssn?: string;
1038
+ citizenshipStatus?: components["schemas"]["CitizenshipStatus"];
1039
+ };
1040
+ LeadSavingsInformation: {
1041
+ /**
1042
+ * Format: int64
1043
+ * @description The minimum amount a `Lead` is interested in depositing when opening a new savings account
1044
+ */
1045
+ minDepositAmount?: number;
1046
+ /**
1047
+ * Format: int64
1048
+ * @description The maximum amount a `Lead` is interested in depositing when opening a new savings account
1049
+ */
1050
+ maxDepositAmount?: number;
1051
+ };
1052
+ /** @description Browsing session information accociated with a `Lead` */
1053
+ LeadSessionInformation: {
1054
+ ipAddress?: string;
1055
+ userAgent?: string;
1056
+ browserFingerprint?: string;
1057
+ };
1058
+ LeadAction: {
1059
+ /** Format: uuid */
1060
+ uuid: string;
1061
+ actionType: components["schemas"]["LeadActionType"];
1062
+ /** Format: date-time */
1063
+ actionDate: string;
1064
+ originatorKey?: string;
1065
+ /** Format: int64 */
1066
+ demandSubAccountId: number;
1067
+ rejectReason?: components["schemas"]["RejectReason"];
1068
+ /** Format: int32 */
1069
+ amount?: number;
1070
+ /** Format: int32 */
1071
+ originationFee?: number;
1072
+ /** Format: int64 */
1073
+ offerClickId?: number;
1074
+ /** Format: date-time */
1075
+ createdAt: string;
1076
+ /** Format: date-time */
1077
+ deletedAt?: string;
1078
+ };
1079
+ /** @enum {string} */
1080
+ LeadActionType:
1081
+ | "initialized"
1082
+ | "api_rejected"
1083
+ | "api_approved"
1084
+ | "api_listing"
1085
+ | "clicked_referral_link"
1086
+ | "clicked_special_offer_link"
1087
+ | "special_offer_conversion"
1088
+ | "applied"
1089
+ | "rejected"
1090
+ | "approved"
1091
+ | "listed"
1092
+ | "funded"
1093
+ | "not_funded"
1094
+ | "clicked_credit_card_offer_link"
1095
+ | "clicked_mortgage_offer_link"
1096
+ | "clicked_savings_offer_link"
1097
+ | "lender_qualified_lead";
1098
+ LeadEvent: {
1099
+ /** @description A hash of the `leadUuid`, `eventType` and `eventCreatedAt` which uniquely identifies a leadEvent. */
1100
+ id: string;
1101
+ /**
1102
+ * Format: uuid
1103
+ * @description The unique identifier for the associated lead.
1104
+ */
1105
+ leadUuid: string;
1106
+ /**
1107
+ * Format: date-time
1108
+ * @description The time that the associated lead was created.
1109
+ */
1110
+ leadCreatedAt: string;
1111
+ eventType: components["schemas"]["EventType"];
1112
+ /**
1113
+ * Format: date-time
1114
+ * @description The time that the event occurred.
1115
+ */
1116
+ eventCreatedAt: string;
1117
+ /** @description Supplemental data about the event that is specific to the `eventType`. For events that occur in a financial institution's experience, the availability of the data may vary depending on the FI. */
1118
+ eventData?: components["schemas"]["EventData"];
1119
+ /**
1120
+ * Format: int32
1121
+ * @description The amount of liquidity provided to the end user by the FI. Only present for some events.
1122
+ */
1123
+ amountInCents?: number;
1124
+ /**
1125
+ * Format: uuid
1126
+ * @description A unique identifier for the associated financial institution. Only present for event types associated with financial institutions.
1127
+ */
1128
+ financialInstitutionUuid?: string;
1129
+ /** @description The name of the associated financial institution. This value is subject to change, so `financialInstitutionUuid` should be used as a stable identifier. Only present for event types associated with financial institutions. */
1130
+ financialInstitutionName?: string;
1131
+ /** @description The product type for the associated offer. Only present for event types associated with offers. */
1132
+ productType?: components["schemas"]["ProductType"];
1133
+ /** @description Whether a `Lead` was created using a test access token */
1134
+ isTest: boolean;
1135
+ };
1136
+ LeadEventResponse: {
1137
+ /** @description The URL for the next request. */
1138
+ nextUrl: string;
1139
+ /**
1140
+ * @description If true, data is currently available at `nextUrl`.
1141
+ * Calling the `nextUrl` at the current time will return the next batch of data.
1142
+ * If false, calling `nextUrl` at the current time will return an error response from the API.
1143
+ * Data will be made available at a later time (at the next hour mark).
1144
+ */
1145
+ shouldContinuePolling: boolean;
1146
+ /** @description Lead event data for the requested time window. */
1147
+ data: components["schemas"]["LeadEvent"][];
1148
+ };
1149
+ LeadPayout: {
1150
+ /**
1151
+ * Format: uuid
1152
+ * @description The unique identifier for the associated lead.
1153
+ */
1154
+ leadUuid: string;
1155
+ /**
1156
+ * Format: date-time
1157
+ * @description The time that this payout to a supply partner was booked.
1158
+ */
1159
+ bookedAt: string;
1160
+ /**
1161
+ * Format: double
1162
+ * @description The payout amount in cents made available to the supply partner. May be fractional.
1163
+ */
1164
+ payoutInCents?: number;
1165
+ /**
1166
+ * Format: uuid
1167
+ * @description The unique identifier for the associated payout event.
1168
+ */
1169
+ uuid?: string;
1170
+ /**
1171
+ * Format: date-time
1172
+ * @description If a payout to a supply partner was revoked, this value will report the time that the payout was revoked.
1173
+ */
1174
+ deletedAt?: string;
1175
+ /** @description The name of the associated financial institution. This value is subject to change, so `financialInstitutionUuid` should be used as a stable identifier. */
1176
+ financialInstitutionName?: string;
1177
+ /**
1178
+ * Format: uuid
1179
+ * @description A unique identifier for the associated financial institution.
1180
+ */
1181
+ financialInstitutionUuid?: string;
1182
+ };
1183
+ LeadPayoutResponse: {
1184
+ /** @description The URL for the next request. */
1185
+ nextUrl: string;
1186
+ /**
1187
+ * @description If true, data is currently available at `nextUrl`.
1188
+ * Calling the `nextUrl` at the current time will return the next batch of data.
1189
+ * If false, calling `nextUrl` at the current time will return an error response from the API.
1190
+ * Data will be made available at a later time (at the next hour mark).
1191
+ */
1192
+ shouldContinuePolling: boolean;
1193
+ /** @description Lead payout data for the requested time window. */
1194
+ data: components["schemas"]["LeadPayout"][];
1195
+ };
1196
+ LeadUuid: {
1197
+ /**
1198
+ * Format: uuid
1199
+ * @description UUID corresponding to the created `Lead`
1200
+ */
1201
+ uuid: string;
1202
+ };
1203
+ /** @description An offer for a life insurance lead */
1204
+ LifeInsuranceOffer: WithRequired<
1205
+ {
1206
+ details: components["schemas"]["LifeInsuranceOfferDetails"];
1207
+ } & components["schemas"]["Offer"],
1208
+ "details"
1209
+ >;
1210
+ LifeInsuranceOfferDetails: {
1211
+ /**
1212
+ * Format: int64
1213
+ * @description Policy amount, in dollars
1214
+ */
1215
+ policyAmount: number;
1216
+ /** Format: int64 */
1217
+ termLength?: number;
1218
+ termUnit?: components["schemas"]["TermUnit"];
1219
+ /** @description Monthly premium amount, in dollars */
1220
+ monthlyPremiumAmount: number;
1221
+ /** @description Annual premium amount, in dollars */
1222
+ annualPremiumAmount?: number;
1223
+ /** @description Semi-annual premium amount, in dollars */
1224
+ semiAnnualPremiumAmount?: number;
1225
+ /** @description Online application is available */
1226
+ onlineAppAvailable?: boolean;
1227
+ noMedicalTest?: boolean;
1228
+ packageType?: components["schemas"]["PackageType"];
1229
+ /** @description Policy is recommended */
1230
+ recommended?: boolean;
1231
+ medicalExam?: components["schemas"]["MedicalExam"];
1232
+ /** @description The name of policy */
1233
+ policyName?: string;
1234
+ carrierDecisionType?: components["schemas"]["CarrierDecisionType"];
1235
+ partnerQuoteId?: string;
1236
+ convertToPermanent?: boolean;
1237
+ childRider?: string;
1238
+ acceleratedDeathBenefit?: boolean;
1239
+ waiverOfPremium?: string;
1240
+ isOnlineApplication?: boolean;
1241
+ deliveryMethod?: string;
1242
+ examRequired?: string;
1243
+ };
1244
+ /** listed */
1245
+ ListedEventData: {
1246
+ /**
1247
+ * Format: int32
1248
+ * @description The dollar amount of the offer that was listed.
1249
+ */
1250
+ amount?: number;
1251
+ /** @description The product type of the offer that was listed. */
1252
+ productType?: components["schemas"]["ProductType"];
1253
+ };
1254
+ LoanOffer: {
1255
+ /** Format: uuid */
1256
+ uuid: string;
1257
+ productType: components["schemas"]["ProductType"];
1258
+ productSubType: components["schemas"]["ProductSubType"];
1259
+ productSubTypeDisclaimer?: string;
1260
+ /** Format: url */
1261
+ url?: string;
1262
+ originator: components["schemas"]["Originator"];
1263
+ originatorId?: string;
1264
+ preQualified: boolean;
1265
+ preApproved: boolean;
1266
+ secured: boolean;
1267
+ coApplicant: boolean;
1268
+ /** @deprecated */
1269
+ sponsored: boolean;
1270
+ /** Format: int32 */
1271
+ maxAmount: number;
1272
+ /** Format: int32 */
1273
+ minAmount?: number;
1274
+ /** Format: int32 */
1275
+ termLength: number;
1276
+ termUnit: components["schemas"]["TermUnit"];
1277
+ displayTermUnit?: string;
1278
+ termDescription?: string;
1279
+ maxApr?: number;
1280
+ minApr?: number;
1281
+ meanApr?: number;
1282
+ aprType: components["schemas"]["AprType"];
1283
+ aprDescription?: string;
1284
+ /**
1285
+ * @deprecated
1286
+ * @description The maximum percent of loan amount fee for an offer. `maxFeeRate` should be used instead
1287
+ */
1288
+ feeRate?: number;
1289
+ maxFeeRate?: number;
1290
+ minFeeRate?: number;
1291
+ /**
1292
+ * @deprecated
1293
+ * @description The maximum fee, in dollars, for an offer. `maxFeeFixed` should be used instead
1294
+ */
1295
+ feeFixed?: number;
1296
+ maxFeeFixed?: number;
1297
+ minFeeFixed?: number;
1298
+ allowPrepayment: boolean;
1299
+ prepaymentFee?: number;
1300
+ /**
1301
+ * @deprecated
1302
+ * @description The estimated maximum monthly payment, in dollars, for an offer. `maxMonthlyPayment` should be used instead
1303
+ */
1304
+ monthlyPayment?: number;
1305
+ maxMonthlyPayment?: number;
1306
+ minMonthlyPayment?: number;
1307
+ monthlyPaymentDescription?: string;
1308
+ meanMonthlyPayment?: number;
1309
+ maxTotalPayment?: number;
1310
+ minTotalPayment?: number;
1311
+ meanTotalPayment?: number;
1312
+ recommendationScore?: number;
1313
+ payout?: number;
1314
+ conversionProbability?: number;
1315
+ terms?: string;
1316
+ /** @description Some loan offers require a prefix (e.g. `up to*`) to be displayed to the left of the displayed loan amount. This is a nullable field that may be up to six characters long. */
1317
+ amountPrefix?: string;
1318
+ };
1319
+ /** @enum {string} */
1320
+ LoanPurpose:
1321
+ | "auto"
1322
+ | "auto_purchase"
1323
+ | "auto_refinance"
1324
+ | "baby"
1325
+ | "boat"
1326
+ | "business"
1327
+ | "car_repair"
1328
+ | "cosmetic"
1329
+ | "credit_card_refi"
1330
+ | "debt_consolidation"
1331
+ | "emergency"
1332
+ | "engagement"
1333
+ | "green"
1334
+ | "home_improvement"
1335
+ | "home_purchase"
1336
+ | "home_refi"
1337
+ | "household_expenses"
1338
+ | "large_purchases"
1339
+ | "life_event"
1340
+ | "medical_dental"
1341
+ | "motorcycle"
1342
+ | "moving_relocation"
1343
+ | "other"
1344
+ | "rv"
1345
+ | "special_occasion"
1346
+ | "student_loan"
1347
+ | "student_loan_refi"
1348
+ | "taxes"
1349
+ | "unknown"
1350
+ | "vacation"
1351
+ | "wedding";
1352
+ LoanProbability: {
1353
+ /**
1354
+ * Format: double
1355
+ * @description The likelihood of approval for loans that match the criteria.
1356
+ */
1357
+ probability: number;
1358
+ /**
1359
+ * Format: double
1360
+ * @description The minimum APR for loans with this approval probability.
1361
+ */
1362
+ aprPercentMin: number;
1363
+ /**
1364
+ * Format: double
1365
+ * @description The maximum APR for loans with this approval probability.
1366
+ */
1367
+ aprPercentMax: number;
1368
+ /**
1369
+ * Format: int64
1370
+ * @description The minimum term length for loans with this approval probability.
1371
+ */
1372
+ termMonthsMin: number;
1373
+ /**
1374
+ * Format: int64
1375
+ * @description The maximum term length for loans with this approval probability.
1376
+ */
1377
+ termMonthsMax: number;
1378
+ /** @description The optional loan sub-type of loans with this approval probability. */
1379
+ productSubType?: components["schemas"]["ProductSubType"];
1380
+ };
1381
+ LoanReport: {
1382
+ /**
1383
+ * Format: uuid
1384
+ * @description A unique identifier for this report.
1385
+ */
1386
+ uuid: string;
1387
+ /**
1388
+ * Format: int32
1389
+ * @description The user's annual income in dollars.
1390
+ */
1391
+ annualIncome: number;
1392
+ /** @description The user's credit score range. */
1393
+ creditRating: components["schemas"]["ProvidedCreditRating"];
1394
+ /**
1395
+ * Format: int32
1396
+ * @description The user's total debt in dollars.
1397
+ */
1398
+ totalDebt?: number;
1399
+ /**
1400
+ * Format: int32
1401
+ * @description The number of derogatory accounts listed on the user's credit report.
1402
+ */
1403
+ countOfDerogatories?: number;
1404
+ /** @description The user's state of residence. */
1405
+ state?: components["schemas"]["State"];
1406
+ /** @description The reason for the loan. */
1407
+ loanPurpose?: components["schemas"]["LoanPurpose"];
1408
+ /**
1409
+ * Format: int32
1410
+ * @description The size of the the loan.
1411
+ */
1412
+ loanAmount?: number;
1413
+ /** @description Probabilities for classes of loans, irrespective of financial institution. */
1414
+ networkProbabilities: components["schemas"]["LoanProbability"][];
1415
+ /** @description Probabilities broken out for specific financial institutions. */
1416
+ financialInsitutions: components["schemas"]["FinancialInstitutionLoanReport"][];
1417
+ /**
1418
+ * Format: date-time
1419
+ * @description When this report was created.
1420
+ */
1421
+ createdAt: string;
1422
+ };
1423
+ LoanReportCreateData: {
1424
+ /**
1425
+ * Format: int32
1426
+ * @description The user's annual income in dollars.
1427
+ */
1428
+ annualIncome: number;
1429
+ /** @description The user's credit score range. */
1430
+ creditRating: components["schemas"]["ProvidedCreditRating"];
1431
+ /**
1432
+ * Format: int32
1433
+ * @description The user's total debt in dollars.
1434
+ */
1435
+ totalDebt?: number;
1436
+ /**
1437
+ * Format: int32
1438
+ * @description The number of derogatory accounts listed on the user's credit report.
1439
+ */
1440
+ countOfDerogatories?: number;
1441
+ /** @description The user's state of residence. */
1442
+ state?: components["schemas"]["State"];
1443
+ /** @description The reason for the loan. */
1444
+ loanPurpose?: components["schemas"]["LoanPurpose"];
1445
+ /**
1446
+ * Format: int32
1447
+ * @description The size of the the loan.
1448
+ */
1449
+ loanAmount?: number;
1450
+ };
1451
+ /**
1452
+ * @description Medical exam requirement
1453
+ * @enum {string}
1454
+ */
1455
+ MedicalExam:
1456
+ | "no_exam_if_qualified"
1457
+ | "no_exam_guaranteed"
1458
+ | "exam_required";
1459
+ /** @enum {string} */
1460
+ MortgageAdjustmentType: "credits" | "par" | "points";
1461
+ /** @enum {string} */
1462
+ MortgageLoanType:
1463
+ | "fifteen_year_fixed"
1464
+ | "thirty_year_fixed"
1465
+ | "five_one_adjustable"
1466
+ | "seven_one_adjustable"
1467
+ | "ten_one_adjustable";
1468
+ /** @description An offer for a mortgage */
1469
+ MortgageOffer: WithRequired<
1470
+ {
1471
+ details: components["schemas"]["MortgageOfferDetails"];
1472
+ } & components["schemas"]["Offer"],
1473
+ "details"
1474
+ >;
1475
+ MortgageOfferDetails: {
1476
+ interestRate: number;
1477
+ loanType: components["schemas"]["MortgageLoanType"];
1478
+ priceAdjustment: number;
1479
+ monthlyPayment: number;
1480
+ netClosingCosts: number;
1481
+ apr: number;
1482
+ /** Format: int32 */
1483
+ loanTerm: number;
1484
+ adjustmentType: components["schemas"]["MortgageAdjustmentType"];
1485
+ };
1486
+ /** @enum {string} */
1487
+ MortgageType: "purchase" | "refinance";
1488
+ /** @enum {string} */
1489
+ OccupancyType: "primary" | "secondary" | "investment";
1490
+ Offer: {
1491
+ /** Format: uuid */
1492
+ uuid: string;
1493
+ partner: components["schemas"]["Partner"];
1494
+ marketplace?: components["schemas"]["Partner"];
1495
+ productType: components["schemas"]["ProductType"];
1496
+ productSubType: components["schemas"]["ProductSubType"];
1497
+ /** Format: url */
1498
+ url: string;
1499
+ recommendationScore?: number;
1500
+ disclaimer?: string;
1501
+ productSubTypeDisclaimer?: string;
1502
+ /** Format: date-time */
1503
+ expiresAt?: string;
1504
+ };
1505
+ /** offerClicked */
1506
+ OfferClickedEventData: {
1507
+ /** @description The product type of the clicked offer. */
1508
+ productType?: components["schemas"]["ProductType"];
1509
+ };
1510
+ OfferDisplay: {
1511
+ /** Format: int64 */
1512
+ id: number;
1513
+ /** Format: uuid */
1514
+ uuid: string;
1515
+ /** Format: uuid */
1516
+ leadUuid: string;
1517
+ /** Format: uuid */
1518
+ rateTableUuid: string;
1519
+ /** Format: uuid */
1520
+ offerUuid: string;
1521
+ /** Format: date-time */
1522
+ createdAt: string;
1523
+ /** Format: uuid */
1524
+ createdBy: string;
1525
+ };
1526
+ OfferDisplayCreateData: {
1527
+ /** Format: uuid */
1528
+ leadUuid: string;
1529
+ /** Format: uuid */
1530
+ rateTableUuid: string;
1531
+ /** Format: uuid */
1532
+ offerUuid: string;
1533
+ };
1534
+ /** @description identification number used by the U.S. Department of Education's Office of Postsecondary Education (OPE) to identify schools that have Program Participation Agreements (PPA) so that its students are eligible to participate in Federal Student Financial Assistance programs under Title IV regulations. This is a 6-digit number followed by a 2-digit suffix used to identify branches, additional locations, and other entities that are part of the eligible institution. */
1535
+ OpeId: string;
1536
+ /** opened */
1537
+ OpenedEventData: {
1538
+ /** @description The product type of the offer for which the account was opened. */
1539
+ productType?: components["schemas"]["ProductType"];
1540
+ };
1541
+ Originator: {
1542
+ key: string;
1543
+ name: string;
1544
+ description?: string;
1545
+ images: components["schemas"]["OriginatorImage"][];
1546
+ disclaimer?: string;
1547
+ /** Format: uuid */
1548
+ companyUuid?: string;
1549
+ /** Format: uuid */
1550
+ financialInstitutionUuid?: string;
1551
+ };
1552
+ OriginatorImage: {
1553
+ sizeKey: string;
1554
+ url: string;
1555
+ };
1556
+ /**
1557
+ * @description Life insurance package types
1558
+ * @enum {string}
1559
+ */
1560
+ PackageType: "basic" | "essential" | "elite";
1561
+ Partner: {
1562
+ /** Format: uuid */
1563
+ uuid: string;
1564
+ name: string;
1565
+ description: string;
1566
+ disclaimer: string;
1567
+ supportsPreSelect: boolean;
1568
+ shouldDisplayPreSelect: boolean;
1569
+ /** @description Whether the partner supports returning pre-qualified or pre-approved offers */
1570
+ supportsPersonalizedOffers: boolean;
1571
+ /** Format: url */
1572
+ imageUrl: string;
1573
+ subtextOverride?: string;
1574
+ };
1575
+ PendingResponse: {
1576
+ partner: components["schemas"]["Partner"];
1577
+ productTypes: components["schemas"]["ProductType"][];
1578
+ };
1579
+ PersonalReferenceInformation: {
1580
+ /** @description The first name of the personal reference supplied by the lead */
1581
+ firstName?: string;
1582
+ /** @description The last name of the personal reference supplied by the lead */
1583
+ lastName?: string;
1584
+ /** @description The phone number of the personal reference supplied by the lead */
1585
+ primaryPhone?: string;
1586
+ /** @description The relation of the personal reference supplied by the lead */
1587
+ relationType?: components["schemas"]["PersonalReferenceRelationType"];
1588
+ };
1589
+ /** @enum {string} */
1590
+ PersonalReferenceRelationType:
1591
+ | "parent"
1592
+ | "employer"
1593
+ | "spouse"
1594
+ | "guardian"
1595
+ | "sibling"
1596
+ | "relative"
1597
+ | "friend"
1598
+ | "other";
1599
+ /** @enum {string} */
1600
+ ProductType:
1601
+ | "credit_card"
1602
+ | "insurance"
1603
+ | "life_insurance"
1604
+ | "loan"
1605
+ | "mortgage"
1606
+ | "savings"
1607
+ | "other";
1608
+ /**
1609
+ * @description A type of financial product
1610
+ * @enum {string}
1611
+ */
1612
+ ProductSubType:
1613
+ | "credit_card"
1614
+ | "secured_card"
1615
+ | "personal_loan"
1616
+ | "secured_loan"
1617
+ | "student_loan_refinance"
1618
+ | "co_applicant_loan"
1619
+ | "line_of_credit"
1620
+ | "automobile_refinance"
1621
+ | "home_equity_line_of_credit"
1622
+ | "purchase"
1623
+ | "refinance"
1624
+ | "savings_account"
1625
+ | "money_market_account"
1626
+ | "certificate_of_deposit"
1627
+ | "individual_retirement_account"
1628
+ | "cash_management_account"
1629
+ | "high_interest_checking"
1630
+ | "checking"
1631
+ | "accidental_death_benefits"
1632
+ | "term_life"
1633
+ | "term_life_instant"
1634
+ | "whole_life"
1635
+ | "debt_relief"
1636
+ | "installment_loans"
1637
+ | "credit_builder"
1638
+ | "cash_advance"
1639
+ | "credit_repair"
1640
+ | "education_offers"
1641
+ | "employment_opportunity"
1642
+ | "financial_wellness"
1643
+ | "direct_affiliate"
1644
+ | "overdraft_protection"
1645
+ | "revenue_based_financing"
1646
+ | "uncategorized";
1647
+ /** @enum {string} */
1648
+ ProvidedCreditRating:
1649
+ | "excellent"
1650
+ | "good"
1651
+ | "fair"
1652
+ | "poor"
1653
+ | "limited"
1654
+ | "unknown";
1655
+ /** @enum {string} */
1656
+ PropertyStatus: "own_outright" | "own_with_mortgage" | "rent";
1657
+ /** @enum {string} */
1658
+ PropertySearchStatus: "found" | "not_found";
1659
+ /** @enum {string} */
1660
+ PropertyType:
1661
+ | "rent"
1662
+ | "condo"
1663
+ | "multi_unit"
1664
+ | "single_family"
1665
+ | "townhouse";
1666
+ /** @enum {string} */
1667
+ PurchaseStatus:
1668
+ | "no_offer"
1669
+ | "offer_accepted"
1670
+ | "offer_pending"
1671
+ | "under_contract";
1672
+ /** @description A `RateTable` customized to a `Lead` input */
1673
+ RateTable: {
1674
+ /**
1675
+ * Format: uuid
1676
+ * @description Primary UUID for a `RateTable`
1677
+ */
1678
+ uuid: string;
1679
+ /**
1680
+ * Format: uuid
1681
+ * @description UUID of the associated `Lead`
1682
+ */
1683
+ leadUuid: string;
1684
+ /**
1685
+ * Format: int32
1686
+ * @description `Lead`'s provided loan amount at the time of `RateTable` creation
1687
+ */
1688
+ loanAmount?: number;
1689
+ /**
1690
+ * Format: url
1691
+ * @description A URL with which to build an iframe to embed rate table offer results in your experience. Only available to channels with integrations configured in control center.
1692
+ */
1693
+ embedUrl?: string;
1694
+ /**
1695
+ * Format: url
1696
+ * @description A partner page URL to send your user to see the rate table offer results. Only available to channels with integrations configured in control center.
1697
+ */
1698
+ partnerPageUrl?: string;
1699
+ creditCardOffers: components["schemas"]["CreditCardOffer"][];
1700
+ loanOffers: components["schemas"]["LoanOffer"][];
1701
+ mortgageOffers: components["schemas"]["MortgageOffer"][];
1702
+ savingsOffers: components["schemas"]["SavingsOffer"][];
1703
+ specialOffers: components["schemas"]["SpecialOffer"][];
1704
+ /**
1705
+ * @deprecated
1706
+ * @description List of originators which have been queried, but have not responded yet. This list only contains loan originators, and should no longer be used
1707
+ */
1708
+ pendingOriginators: components["schemas"]["Originator"][];
1709
+ /** @description List of demand partners which have been queried, but have not responded yet. It is a guarantee that no offers will be added to the rate table after this list is empty */
1710
+ pendingResponses: components["schemas"]["PendingResponse"][];
1711
+ };
1712
+ /** Refinance loan information */
1713
+ RefinanceLoanInformation: {
1714
+ /** @description The account number for a loan the lead is refinancing */
1715
+ accountNumber?: string;
1716
+ /** @description If the repayment is income-based for a loan the lead is refinancing */
1717
+ incomeBasedRepayment?: boolean;
1718
+ /**
1719
+ * Format: float
1720
+ * @description The interest rate for a loan the lead is refinancing
1721
+ */
1722
+ interestRate?: number;
1723
+ /**
1724
+ * Format: int32
1725
+ * @description The loan amount for a loan the lead is refinancing
1726
+ */
1727
+ loanAmount?: number;
1728
+ /** @description The name of a loan servicer of a loan the lead is refinancing */
1729
+ loanServicer?: string;
1730
+ /** @description The loan type for a loan the lead is refinancing */
1731
+ loanType?: components["schemas"]["RefinanceLoanType"];
1732
+ /**
1733
+ * Format: float
1734
+ * @description The amount the next payment will be on a loan the lead is refinancing
1735
+ */
1736
+ nextPaymentAmount?: number;
1737
+ /**
1738
+ * Format: date
1739
+ * @description The next payment date for a loan the lead is refinancing
1740
+ */
1741
+ nextPaymentDate?: string;
1742
+ };
1743
+ /** @enum {string} */
1744
+ RefinanceLoanType: "federal_student_loan" | "private_student_loan";
1745
+ /** @enum {string} */
1746
+ RefinanceType: "cash_out" | "rate_term";
1747
+ /** @enum {string} */
1748
+ RejectReason:
1749
+ | "low_fico"
1750
+ | "no_fico"
1751
+ | "major_derogatory"
1752
+ | "underwriting_decline"
1753
+ | "debt_to_income_ratio"
1754
+ | "not_in_active_state"
1755
+ | "incorrect_data_provided"
1756
+ | "duplicate";
1757
+ /** @description An offer for a savings account */
1758
+ SavingsOffer: WithRequired<
1759
+ {
1760
+ details: components["schemas"]["SavingsOfferDetails"];
1761
+ } & components["schemas"]["Offer"],
1762
+ "details"
1763
+ >;
1764
+ SavingsOfferDetails: {
1765
+ name?: string;
1766
+ description?: string;
1767
+ details?: string;
1768
+ /** @description Annual interest rate */
1769
+ rate?: number;
1770
+ annualPercentYield: number;
1771
+ compoundingMethod: components["schemas"]["CompoundingMethod"];
1772
+ /** Format: int32 */
1773
+ introductoryPeriodMonths?: number;
1774
+ introductoryRate?: number;
1775
+ minimumDeposit: number;
1776
+ minimumDepositWithFees?: number;
1777
+ monthlyFee: number;
1778
+ /** @description Whether the account allows checks */
1779
+ checkWriting?: boolean;
1780
+ /**
1781
+ * Format: date-time
1782
+ * @description When the offer was last validated, formatted as yyyy-MM-ddTHH:mm:ss.SSSZZ
1783
+ */
1784
+ effectiveAsOf: string;
1785
+ /**
1786
+ * @description The type of federal deposit insurance that applies to this offer, if
1787
+ * it was provided by the financial institution. Could be one of `fdic` for
1788
+ * the Federal Deposit Insurance Corporation, or `ncua` for the National
1789
+ * Credit Union Administration.
1790
+ */
1791
+ federalInsuranceType?: components["schemas"]["FederalInsuranceType"];
1792
+ incentiveDetails?: components["schemas"]["IncentiveDetails"][];
1793
+ cdTermUnit?: components["schemas"]["TermUnit"];
1794
+ /** Format: int32 */
1795
+ cdTermLength?: number;
1796
+ };
1797
+ SessionInit: {
1798
+ /** Format: int64 */
1799
+ id: number;
1800
+ /** Format: uuid */
1801
+ uuid: string;
1802
+ /** Format: uuid */
1803
+ sessionUuid: string;
1804
+ /** Format: date-time */
1805
+ createdAt: string;
1806
+ /** Format: uuid */
1807
+ createdBy: string;
1808
+ };
1809
+ SessionInitCreateData: {
1810
+ /**
1811
+ * Format: uuid
1812
+ * @description You may specify the session's UUID; if you don't, one will be generated for you.
1813
+ */
1814
+ sessionUuid?: string;
1815
+ };
1816
+ SpecialOffer: {
1817
+ /** Format: uuid */
1818
+ uuid: string;
1819
+ name: string;
1820
+ /** @description Description */
1821
+ desc: string;
1822
+ /** Format: url */
1823
+ url: string;
1824
+ partnerName: string;
1825
+ /** Format: url */
1826
+ partnerImageUrl: string;
1827
+ recommendationScore?: number;
1828
+ payout?: number;
1829
+ productSubType: components["schemas"]["ProductSubType"];
1830
+ disclaimer?: string;
1831
+ };
1832
+ /**
1833
+ * state
1834
+ * Format: state
1835
+ * @description A two character upper case state, Puerto Rico, or District of Columbia code
1836
+ * @enum {string}
1837
+ */
1838
+ State:
1839
+ | "AK"
1840
+ | "AL"
1841
+ | "AR"
1842
+ | "AZ"
1843
+ | "CA"
1844
+ | "CO"
1845
+ | "CT"
1846
+ | "DC"
1847
+ | "DE"
1848
+ | "FL"
1849
+ | "GA"
1850
+ | "HI"
1851
+ | "IA"
1852
+ | "ID"
1853
+ | "IL"
1854
+ | "IN"
1855
+ | "KS"
1856
+ | "KY"
1857
+ | "LA"
1858
+ | "MA"
1859
+ | "MD"
1860
+ | "ME"
1861
+ | "MI"
1862
+ | "MN"
1863
+ | "MO"
1864
+ | "MS"
1865
+ | "MT"
1866
+ | "NC"
1867
+ | "ND"
1868
+ | "NE"
1869
+ | "NH"
1870
+ | "NJ"
1871
+ | "NM"
1872
+ | "NV"
1873
+ | "NY"
1874
+ | "OH"
1875
+ | "OK"
1876
+ | "OR"
1877
+ | "PA"
1878
+ | "PR"
1879
+ | "RI"
1880
+ | "SC"
1881
+ | "SD"
1882
+ | "TN"
1883
+ | "TX"
1884
+ | "UT"
1885
+ | "VA"
1886
+ | "VI"
1887
+ | "VT"
1888
+ | "WA"
1889
+ | "WI"
1890
+ | "WV"
1891
+ | "WY";
1892
+ /**
1893
+ * @description Unit of measure for offer term lengths, or open for a single term.
1894
+ *
1895
+ * @enum {string}
1896
+ */
1897
+ TermUnit: "day" | "month" | "year" | "open";
1898
+ VehicleDetails: {
1899
+ /**
1900
+ * Format: int32
1901
+ * @description Year of the vehicle.
1902
+ */
1903
+ year: number;
1904
+ /** @description Make of the vehicle. */
1905
+ make: string;
1906
+ /** @description Model of the vehicle. */
1907
+ model: string;
1908
+ /** @description Trim of the vehicle. */
1909
+ trim: string;
1910
+ /**
1911
+ * Format: uuid
1912
+ * @description A unique identifier for this vehicle.
1913
+ */
1914
+ uuid: string;
1915
+ /**
1916
+ * Format: int64
1917
+ * @description NADA Used Card Guide vehicle id.
1918
+ */
1919
+ ucgVehicleId: number;
1920
+ };
1921
+ /** Vehicle information */
1922
+ VehicleInformation: {
1923
+ /**
1924
+ * Format: int32
1925
+ * @description The lead's monthly auto loan payment
1926
+ */
1927
+ monthlyPayment?: number;
1928
+ /**
1929
+ * Format: integer
1930
+ * @description The vehicle's estimated number of miles driven
1931
+ */
1932
+ estimatedMileage?: number;
1933
+ /** @description The vehicle identification number (VIN) of the financed vehicle */
1934
+ vehicleIdentificationNumber?: string;
1935
+ /**
1936
+ * Format: uuid
1937
+ * @description A vehicle UUID that corresponds to a valid combination of vehicle year, make, model, and trim. See the [vehicle utility endpoints](https://engine.tech/docs/api-reference/#even-financial-api-ui-utils)
1938
+ */
1939
+ vehicleUuid?: string;
1940
+ };
1941
+ };
1924
1942
  }