Even Financial UI Utils API

openapi: 3.2.0
info:
  title: Engine by MoneyLion UI Utils API
  version: 1.106.0
  termsOfService: https://engine.tech/about/legal#terms
  contact:
    name: API Support
    url: https://engine.tech/docs
    email: help@engine.tech
  description: A collection of endpoints that can be used to improve a search experience.
servers:
- url: https://api.engine.tech
tags:
- name: UI Utils
  description: A collection of endpoints that can be used to improve a search experience.
paths:
  /leads/universities:
    get:
      x-implemented-by:
        service: lead
        path: /leads/universities
      summary: Get university names
      description: 'Get a list of university names that correspond to the specified fragment.


        This is useful for implementing an autocomplete input for the `educationInformation.universityAttended` lead field when searching for student loan refinancing loans. See the Student Loan Refinancing overview.'
      operationId: getUniversities
      security:
      - publishableBearerToken: []
      tags:
      - UI Utils
      parameters:
      - name: name
        in: query
        description: Fragment of a university name to seach for.
        schema:
          type: string
      - name: offset
        in: query
        description: Number of results to skip before the first returned result.
        schema:
          type: integer
          format: int64
          minimum: 0
          default: 0
      - name: limit
        in: query
        description: Maximum number of results to return.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              examples:
                universityNamesMatchingJohns:
                  $ref: '#/components/examples/UniversityNamesMatchingJohns'
        '401':
          $ref: '#/components/responses/UnauthorizedRequest'
  /leads/vehicles/years:
    get:
      x-lint-skip:
      - index-endpoint-has-limit
      summary: Get vehicle years
      description: 'Get all available vehicle years


        This is useful for implementing a select input for vehicle years when searching for auto loan refinancing loans. A valid combination of year, make, model, and trim corresponds to a vehicle UUID that can be used in the `vehicleInformation.vehicleUuid` field. See the Auto Loan Refinancing overview.'
      operationId: getVehicleYears
      security:
      - publishableBearerToken: []
      tags:
      - UI Utils
      parameters:
      - name: minYear
        in: query
        schema:
          type: integer
          format: int32
      - name: maxYear
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Valid vehicle years
          content:
            application/json:
              schema:
                type: array
                items:
                  type: integer
                  format: int32
  /leads/vehicles/makes:
    get:
      x-lint-skip:
      - index-endpoint-has-limit
      summary: Get vehicle makes
      description: 'Get all makes for the given vehicle year


        This is useful for implementing a select input for vehicle makes when searching for auto loan refinancing loans. A valid combination of year, make, model, and trim corresponds to a vehicle UUID that can be used in the `vehicleInformation.vehicleUuid` field. See the Auto Loan Refinancing overview.'
      operationId: getVehicleMakes
      security:
      - publishableBearerToken: []
      tags:
      - UI Utils
      parameters:
      - name: year
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Makes for given vehicle year
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '400':
          $ref: '#/components/responses/InvalidRequest'
  /leads/vehicles/models:
    get:
      x-lint-skip:
      - index-endpoint-has-limit
      summary: Get vehicle models
      description: 'Get all models for the given vehicle year and make


        This is useful for implementing a select input for vehicle models when searching for auto loan refinancing loans. A valid combination of year, make, model, and trim corresponds to a vehicle UUID that can be used in the `vehicleInformation.vehicleUuid` field. See the Auto Loan Refinancing overview.'
      operationId: getVehicleModels
      security:
      - publishableBearerToken: []
      tags:
      - UI Utils
      parameters:
      - name: year
        in: query
        schema:
          type: integer
          format: int32
      - name: make
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Models for given vehicle year and make
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '400':
          $ref: '#/components/responses/InvalidRequest'
  /leads/vehicles/trims:
    get:
      x-lint-skip:
      - index-endpoint-has-limit
      summary: Get vehicle trims
      description: 'Get vehicle details, including trims and uuids, for the given year, make, and model


        This is useful for implementing a select input for vehicle trims when searching for auto loan refinancing loans. A valid combination of year, make, model, and trim corresponds to a vehicle UUID that can be used in the `vehicleInformation.vehicleUuid` field. The uuid field returned in successful response objects corresponds to a valid `vehicleUuid`. See the Auto Loan Refinancing overview.'
      operationId: getVehicleTrims
      security:
      - publishableBearerToken: []
      tags:
      - UI Utils
      parameters:
      - name: year
        in: query
        schema:
          type: integer
          format: int32
      - name: make
        in: query
        schema:
          type: string
      - name: model
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Vehicle details, including trim and uuid, for the given year, make, model
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VehicleDetails'
        '400':
          $ref: '#/components/responses/InvalidRequest'
  /uiUtil/featuredFinancialInstitutions:
    x-implemented-by:
      service: partner-data
      path: /userExperience/featuredFinancialInstitutions
    get:
      summary: Get featured financial institutions
      description: Get a list of featured financial institution names and logos that can be displayed prior to collecting personal information in a search application to improve the user experience.
      operationId: getFeaturedFinancialInstitutions
      security:
      - publishableBearerToken: []
      tags:
      - UI Utils
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FeaturedFinancialInstitution'
              examples:
                featuredFinancialInstitutions:
                  $ref: '#/components/examples/FeaturedFinancialInstitutions'
        '401':
          $ref: '#/components/responses/UnauthorizedRequest'
        '422':
          description: Invalid request
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiError'
components:
  schemas:
    VehicleDetails:
      type: object
      required:
      - year
      - make
      - model
      - trim
      - uuid
      - ucgVehicleId
      properties:
        year:
          type: integer
          format: int32
          description: Year of the vehicle.
        make:
          type: string
          description: Make of the vehicle.
        model:
          type: string
          description: Model of the vehicle.
        trim:
          type: string
          description: Trim of the vehicle.
        uuid:
          type: string
          format: uuid
          description: A unique identifier for this vehicle.
        ucgVehicleId:
          type: integer
          format: int64
          description: NADA Used Card Guide vehicle id.
    ApiError:
      type: object
      properties:
        attribute:
          type: string
          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.

            '
        type:
          type: string
          description: 'A classification for this error, which can be used to render the appropriate custom error template, or take other programmatic actions.

            '
        details:
          description: 'Variables associated with this error that can be injected into a custom error template, or used to parameterize any other programatic actions.

            '
          allOf:
          - $ref: '#/components/schemas/ApiErrorDetails'
        message:
          type: string
          description: 'A human-readable, English description of the error.

            '
    ApiErrorDetails:
      type: object
      additionalProperties:
        type: string
    FeaturedFinancialInstitution:
      type: object
      required:
      - uuid
      - name
      - logoUrl
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
          description: 'A unique identifier for the financial institution.

            '
        name:
          type: string
          readOnly: true
          description: 'The name of the financial institution. This value is subject to

            change, so `financialInstitutionUuid` should be used for grouping.

            '
        logoUrl:
          type: string
          format: url
          readOnly: true
          description: 'The URL of an image logo for the associated financial institution.

            '
  examples:
    FeaturedFinancialInstitutions:
      summary: Featured financial institutions
      value:
      - uuid: 32bd2f7c-79fd-5c54-bcb5-3a46454a465c
        name: Alpha, Inc.
        logoUrl: https://aff-tag.evenfinancial.com/images/alpha/Alpha_120x80.png
      - uuid: 91d08be0-2a8c-4d28-b399-7e1b38e2522e
        name: Beta, Inc.
        logoUrl: https://aff-tag.evenfinancial.com/images/beta/Beta_120x80.png
    UniversityNamesMatchingJohns:
      summary: University names matching "johns"
      value:
      - Johns Hopkins University
      - Johns Hopkins University - Carey Business School
      - Johns Hopkins University - Paul Nifle School of Advanced International Studies
      - Johns Hopkins University - Peabody Conservatory of Music
      - Johns Hopkins University - School of Arts & Science
      - Johns Hopkins University - School of Medicine
      - Johns Hopkins University - School of Nursing
      - Johns Hopkins University - School of Public Health
      - Johns Hopkins University - SPSBE
      - Saint Johns University
      - Cornell University Johnson, MBA
      - Johnson College
      - Johnson County Community College
      - Johnson University
      - Johnson & Wales University
      - Northern Vermont University - Johnson (FKA Johnson State College + Lyndon State College)
      - Northern Vermont University - Lyndon (FKA Lyndon State College + Johnson State College)
      - University of Pittsburgh - Johnstown
  responses:
    InvalidRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ApiError'
    UnauthorizedRequest:
      description: Unauthorized request
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ApiError'
          examples:
            missingAccessToken:
              summary: Access token was not specified
              value:
              - message: Access token is missing
  securitySchemes:
    publishableBearerToken:
      type: http
      scheme: bearer
      description: 'A bearer token that is assumed to be published in application code and downloaded to a user''s device. As a result, it only has restricted access to the API.

        '
    confidentialBearerToken:
      type: http
      scheme: bearer
      description: 'A bearer token that is assumed to be managed like a password or any other confidential secret. As a result, it has access to sensitive API endpoints.

        '
    experimentalBearerToken:
      type: http
      scheme: bearer
      description: 'A bearer token that is used to access experimental endpoints that are not yet available for all partners. It may be treated the same as a `publishableBearerToken`.

        '
externalDocs:
  description: Engine by MoneyLion API Reference
  url: https://engine.tech/docs/api-reference/