Developer Docs
Hubex
Technical Changelog
Version 1.1.81

API Docs Version 1.1.81

What's New

POST /identity/verify-identity

Verify Identity

POST /dms/deals/convert-to-contract

Convert to Contract

GET /dms/get-lenders

Get Lender Information.

POST /pricing/get-fni-monthly-payment-impact

Get FnI Monthly Payment Impact

POST /tax/get-pricing

Get Pricing

POST /tax/get-vehicles-by-vin-params

Get Vehicles by VIN Params

POST /tax/get-product-payment

Get Product Payment

GET /tax/get-market-by-zip/{zip_code}

Get Market by zipcode

POST /contract

Contract Management

POST /tagging/send-tagging

Digital Retail Tagging

POST /program/get-programs

Get Programs

POST /document/get-document

Get document

PUT /inventory

Update Vehicle Inventory

POST /inventory

Create Vehicle Inventory

POST /get-inventory

Get Vehicle Inventory

POST /email/send-order-credit-email

Send Order Credit Email

POST /email/send-order-quotation-email

Send Order Quotation Email

POST /deal-status

Update Deal Status

What's Deleted

GET /payment/charges

Get payment charges

POST /payment/create-payment

Create payment through single API

GET /dms/inventory

Get Vehicle Inventory

PUT /dms/inventory

Update Vehicle Inventory

POST /dms/inventory

Create Vehicle Inventory

DELETE /payment/customers/{customer_id}

Delete a customer

What's Changed

POST /set-dealer

Request:

Changed content type : application/json

  • Changed property fax (string)

    Fax Number

  • Changed property phone (string)

    Dealer's Phone Number

  • Changed property state (string)

    State or Province Name. Example: 'CA' for California.

POST /set-deal

Request:

Changed content type : application/json

  • Changed property deal_number (string)

    Deal Number from External Provider.

POST /void-contract

Request:

Changed content type : application/json

  • Changed property pen_dealer_id (integer)

    PEN Dealer Id number, this is returned by '/set-dealer' endpoint of hubex.

  • Changed property form_id (integer)

    Dealer's form id for this product, this is returned by '/get-rates' endpoint of hubex.

POST /payment/payment-intents

Request:

Changed content type : application/json

  • Changed property amount (number)

    Amount intended to be collected by this Payment Intent.

  • Changed property payment_method_type (string)

    The type of payment method (e.g. 'card', 'us_bank_account') that this Payment Intent is allowed to use.

  • Changed property source (string)

    The payment description for this Payment Intent.

  • Changed property expires_at (string)

    The date for which payment will expire for this Payment Intent.

  • Changed property items (object)

    The items list for this Payment Intent.

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property amount (number)

      Amount intended to be collected by this Payment Intent.

    • Changed property amount_capturable (integer)

      Amount that can be captured from this Payment Intent.

    • Changed property amount_received (integer)

      Amount that was collected by this Payment Intent.

    • Changed property client_secret (string)

      The client secret of this Payment Intent

    • Changed property customer (string)

      ID of the Customer this Payment Intent belongs to, if one exists.

    • Changed property payment_method (string)

      ID of the payment method used in this Payment Intent.

    • Changed property status (string)

      Status of this Payment Intent.

POST /payment/link/token

Request:

Changed content type : application/json

  • Changed property user_id (integer -> string)

    A unique ID representing the end user. Typically this will be a user ID from your application.

GET /payment/invoice-items

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/invoice-items

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/invoice-items/{invoice_item_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /events/{event_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /events

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /dms/customers/search

Parameters:

Changed: x-service-provider in header

Provider Name

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /e-sign/consent

Parameters:

Changed: x-service-provider in header

E-Signature Service provider to use

GET /api-version

POST /tradein/get-tradein-years

Request:

Changed content type : application/json

  • Changed property filter (object)

    Please specify a filter for years.

POST /tradein/get-tradein-makes

Request:

Changed content type : application/json

  • Changed property filter (object)

    Please specify a filter for makes.

POST /tradein/get-tradein-models

Request:

Changed content type : application/json

  • Changed property filter (object)

    Please specify a filter for models.

POST /tradein/get-tradein-modelyears

Request:

Changed content type : application/json

  • Changed property filter (object)

    Please specify a filter for model year.

POST /tradein/get-tradein-allOptions

Request:

Changed content type : application/json

  • Changed property filter (object)

    Please provide filter for options.

POST /tradein/get-tradein-vehicle

Request:

Changed content type : application/json

  • Changed property filter (object)

    All, Decoded Only. Indicates the scope of options returned.

POST /payment/refunds

Request:

Changed content type : application/json

  • Changed property payment_intent (string)

    ID of the Payment Intent to refund. Pass either payment_intent or charge.

GET /payment/refunds

Parameters:

Changed: payment_intent in query

ID of the Payment Intent to refund.

POST /payment/invoices/upcoming

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property customer_shipping (string -> object)

    • Changed property from_invoice (string -> object)

POST /credit/check

Parameters:

Added: x-dealer-code in header

Changed: x-service-provider in header

Credit service to use

Request:

Changed content type : application/json

  • Changed property ignore_cache (boolean)

    If True, the cached data will be ignored and fresh data will be fetched.

  • Changed property addresses (array)

    List of addresses associated with the individual

    Changed items (object):

    • Added property state (string)

    • Deleted property state_name (string)

    • Deleted property state_code (string)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • consumer

    • Added property transunion (object)

      • Property addresses (object)

        List of address against the user

      • Property consumer (object)

        Consumer Information

        • Property first_name (string)

          Consumer First Name

        • Property middle_name (string)

          Conumer Middle Name

        • Property last_name (string)

          Consumer Last Name

        • Property date_of_birth (string)

          Consumer Date of Birth

      • Property phones (object)

        Consumer Contact Phone Numbers

      • Property social_security_number (string)

        Consumer Social Security Number

      • Property trade (array)

        Credit Trade Information

        Items (object):

        • Property account_number (string)

        • Property activity_open_closed (string)

          Either Activity is closed or open

        • Property customer_number (string)

          Customer Trade Number

        • Property account_type (string)

          Customer Account Type

        • Property months_reviewed (integer)

        • Property customer_name (string)

        • Property date_reported (string)

        • Property date_opened (string)

        • Property last_payment_date (string)

        • Property amount1 (string)

        • Property amount2 (string)

        • Property terms (string)

        • Property balance_date (string)

        • Property payment_data (object)

          • Property compliance_condition (string)

          • Property credit_limit_amount (string)

          • Property enhanced_account_condition (string)

          • Property enhanced_account_type (string)

          • Property enhanced_payment_history (string)

          • Property enhanced_payment_status (string)

          • Property enhanced_special_comment (string)

          • Property enhanced_terms (string)

          • Property enhanced_terms_frequency (string)

          • Property high_balance_amount (string)

          • Property payment_level_date (string)

      • Property risk_model (object)

        • Property score (integer)

        • Property score_factor (array)

          Items (object):

          • Property code (integer)

        • Property model_indicator (string)

        • Property evaluation (string)

        • Property score_number_marketing_industry (string)

    • Added property experian (object)

    • Added property equifax (object)

    • Deleted property addresses (object)

      List of address against the user

    • Deleted property consumer (object)

      Consumer Information

    • Deleted property phones (object)

      Consumer Contact Phone Numbers

    • Deleted property social_security_number (string)

      Consumer Social Security Number

    • Deleted property trade (array)

      Credit Trade Information

    • Deleted property risk_model (object)

GET /e-sign/status/{signature_id}

Parameters:

Changed: x-service-provider in header

E-Signature Service provider to use

GET /product

PUT /product/{product_id}

DELETE /product/{product_id}

POST /customer/without-charge

POST /customer/without-card

POST /customer/payment-method/attach/{stripe_customer_id}

Request:

Changed content type : application/json

  • Changed property payment_method (object)

    Defines method needed for payments

POST /get-rates

Request:

Changed content type : application/json

  • Changed property deal_info (object)

    Information specific to the entire Deal. See DSIDealInfo.

    • Changed property vehicle_msrp (number)

      Vehicle manufacturer's suggested retail price or NADA value.

POST /get-preview-form

Request:

Changed content type : application/json

  • Changed property product (object)

    Pen product details.

    • Changed property pen_dealer_id (integer)

      PEN Dealer Id number, this is returned by '/set-dealer' endpoint of hubex.

    • Changed property pen_product_id (integer)

      Product Id to rate, this is returned by '/get-dealer-products' endpoint of hubex.

    • Changed property form_id (integer)

      Dealer's form id for this product, this is returned by '/get-rates' endpoint of hubex.

    • Changed property rate_id (integer)

      Dealer's rate id for this product, this is returned by '/get-rates' endpoint of hubex.

    • Changed property session_id (string)

      Dealer's session id for this product, this is returned by '/get-rates' endpoint of hubex.

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property pdf_form (string)

      PDF Form available in Base64 format

POST /get-filled-form

Request:

Changed content type : application/json

  • Changed property product (object)

    Pen product details.

    • Changed property pen_dealer_id (integer)

      PEN Dealer Id number, this is returned by '/set-dealer' endpoint of hubex.

    • Changed property pen_product_id (integer)

      Product Id to rate, this is returned by '/get-dealer-products' endpoint of hubex.

    • Changed property form_id (integer)

      Dealer's form id for this product, this is returned by '/get-rates' endpoint of hubex.

    • Changed property rate_id (integer)

      Dealer's rate id for this product, this is returned by '/get-rates' endpoint of hubex.

    • Changed property session_id (string)

      Dealer's session id for this product, this is returned by '/get-rates' endpoint of hubex.

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property pdf_form (string)

      PDF Form available in Base64 format

POST /payment/invoices/search-by-metadata

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property customer_shipping (string -> object)

    • Changed property from_invoice (string -> object)

    • Changed property automatic_tax (object)

      • Changed property enabled (boolean)

        Indicates if automatic tax is enabled

      • Changed property liability (string -> object)

        Liability details for automatic tax

      • Changed property status (string)

        Status of automatic tax

GET /payment/invoices/{invoice_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property customer_shipping (string -> object)

    • Changed property from_invoice (string -> object)

    • Changed property automatic_tax (object)

      • Changed property enabled (boolean)

        Indicates if automatic tax is enabled

      • Changed property liability (string -> object)

        Liability details for automatic tax

      • Changed property status (string)

        Status of automatic tax

PATCH /payment/invoices/{invoice_id}

Request:

Changed content type : application/json

  • Changed property payment_settings (object)

    Configuration settings for the Payment Intent that is generated when the invoice is finalized.

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property customer_shipping (string -> object)

    • Changed property from_invoice (string -> object)

    • Changed property automatic_tax (object)

      • Changed property enabled (boolean)

        Indicates if automatic tax is enabled

      • Changed property liability (string -> object)

        Liability details for automatic tax

      • Changed property status (string)

        Status of automatic tax

POST /payment/invoices/{invoice_id}/send

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property customer_shipping (string -> object)

    • Changed property from_invoice (string -> object)

    • Changed property automatic_tax (object)

      • Changed property enabled (boolean)

        Indicates if automatic tax is enabled

      • Changed property liability (string -> object)

        Liability details for automatic tax

      • Changed property status (string)

        Status of automatic tax

POST /payment/invoices/{invoice_id}/void

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property customer_shipping (string -> object)

    • Changed property from_invoice (string -> object)

    • Changed property automatic_tax (object)

      • Changed property enabled (boolean)

        Indicates if automatic tax is enabled

      • Changed property liability (string -> object)

        Liability details for automatic tax

      • Changed property status (string)

        Status of automatic tax

POST /dms/customers

Parameters:

Changed: x-service-provider in header

Provider Name

Request:

Changed content type : application/json

  • Changed property preferred_contact_type (string)

    An enumeration.

    Added enum values:

    • CALL
    • EMAIL
    • SMS

GET /dms/customers/{customer_id}

Parameters:

Changed: x-service-provider in header

Provider Name

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property preferred_contact_type (string)

      An enumeration.

      Added enum values:

      • CALL
      • EMAIL
      • SMS

PUT /dms/customers/{customer_id}

Parameters:

Changed: x-service-provider in header

Provider Name

Request:

Changed content type : application/json

  • Changed property preferred_contact_type (string)

    An enumeration.

    Added enum values:

    • CALL
    • EMAIL
    • SMS

GET /api/verify-address/{address}

Address Verification

Parameters:

Deleted: x-api-version in header

API version. e.g 1.1 or 1.0

POST /pricing/get-pricing

Request:

Changed content type : application/json

  • Changed property parameters (array)

    Pricing request information

    Changed items (object):

    • Changed property finance (object)

      Pricing Finance information

      • Added property tax_on_selling_price (number)

        For Deal type Retail Tax on selling price will be added into market scan FlatTax request parameter for tax calculation

    • Changed property fni_products (array)

      FnI Products information

      Changed items (object):

      • Changed property name (string)

        Description of the FnI product

      • Changed property price (number)

        Price of the FnI product

POST /e-sign

Parameters:

Changed: x-service-provider in header

E-Signature Service provider to use

POST /leads

Request:

Changed content type : application/json

  • Changed property vehicles (array)

    List of vehicles

    Changed items (object):

    • Changed property status (string)

      An enumeration.

      Added enum value:

      • PO Removed enum value:

      • Po

GET /leads/{customer_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property vehicles (array)

      List of vehicles

      Changed items (object):

      • Changed property status (string)

        An enumeration.

        Added enum value:

        • PO Removed enum value:

        • Po

PATCH /leads/{customer_id}

Request:

Changed content type : application/json

  • Changed property vehicles (array)

    List of vehicles

    Changed items (object):

    • Changed property status (string)

      An enumeration.

      Added enum value:

      • PO Removed enum value:

      • Po

POST /customer/with-charge

POST /customer/payment-method

Request:

Changed content type : application/json

  • Changed property payment_method (object)

    Defines method needed for payments

POST /payment/invoices

Request:

Changed content type : application/json

  • Changed property payment_settings (object)

    Configuration settings for the Payment Intent that is generated when the invoice is finalized.

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property customer_shipping (string -> object)

    • Changed property from_invoice (string -> object)

    • Changed property automatic_tax (object)

      • Changed property enabled (boolean)

        Indicates if automatic tax is enabled

      • Changed property liability (string -> object)

        Liability details for automatic tax

      • Changed property status (string)

        Status of automatic tax

GET /payment/invoices

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property data (array)

      Changed items (object):

      • Changed property customer_shipping (string -> object)

      • Changed property from_invoice (string -> object)

      • Changed property automatic_tax (object)

        • Changed property enabled (boolean)

          Indicates if automatic tax is enabled

        • Changed property liability (string -> object)

          Liability details for automatic tax

        • Changed property status (string)

          Status of automatic tax

GET /payment/invoices/search

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property data (array)

      Changed items (object):

      • Changed property customer_shipping (string -> object)

      • Changed property from_invoice (string -> object)

      • Changed property automatic_tax (object)

        • Changed property enabled (boolean)

          Indicates if automatic tax is enabled

        • Changed property liability (string -> object)

          Liability details for automatic tax

        • Changed property status (string)

          Status of automatic tax

GET /payment/invoices/search-by-query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property data (array)

      Changed items (object):

      • Changed property customer_shipping (string -> object)

      • Changed property from_invoice (string -> object)

      • Changed property automatic_tax (object)

        • Changed property enabled (boolean)

          Indicates if automatic tax is enabled

        • Changed property liability (string -> object)

          Liability details for automatic tax

        • Changed property status (string)

          Status of automatic tax

POST /fraud-identification/email-auth-score

Request:

Changed content type : application/json

  • Changed property email (string)

    The user’s email address. Must conform to RFC 5322 format and contain a valid top-level domain. (e.g. john.doe@example.com)

  • Changed property modules (array)

    Fraud Identification Service modules to check for this request.

  • Changed property ignore_cache (boolean)

    If True, the cached data will be ignored and fresh data will be fetched.

GET /configuration

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property ascent_configuration (object)

      Ascent Configurations

      • Property token_url (string)

        Authentication Token API URL

      • Property webhook_url (string)

        Webhook URL

      • Property api_url (string)

        API Base URL for Documents

      • Property client_id (string)

        Client ID

      • Property client_secret (string)

        client secret

    • Added property inventory_server (object)

      Configuration for inventory server

      • Property sd_inventory (object)

        Shift Digital Server Configuration

        • Property host (string)

          Host name for Shift Digital Server

        • Property username (string)

          Username for Shift Digital Server

        • Property password (string)

          Password for Shift Digital Server

        • Property port (integer)

          Port for Shift Digital Server

    • Added property inventory_management (object)

      Configuration for the Inventory Management services

      • Property homenet (object)

        Homenet Configuration

        • Property api_url (string)

          API key for the Inventory Management

        • Property secret_key (string)

          Secret key for the Inventory Management

      • Property bmw_inventory (object)

        BMW Inventory

        • Property token_url (string)

          Token Url for the Credit & Contract Management

        • Property api_url (string)

          API Url for the Credit & Contract Management

        • Property client_id (string)

          Client ID for the Credit & Contract Management

        • Property client_secret (string)

          Client Secret for the Credit & Contract Management

    • Changed property credit_application (object)

      Configuration for Credit Application

      • Changed property transunion (object)

        TransUnion Configuration

        • Changed property certificate_file (string)

          The user needs to convert its .p12 format certificate file into a base 64 string format by following these steps:

          Send a request to the configuration endpoint of Hubex.

          • A certificate file will be generated on the AWS cloud, and the response will display certificate_file as certificate_5555.
          • Now you can utilize the TransUnion third-party service.

    • Changed property dealer_management_system (object)

      Configuration for dms

      • Added property routeone (object)

        RouteOne Configuration

        • Property api_url (string)

          API Base URL

        • Property dealership_id (string)

          Dealership ID

        • Property partner_id (string)

          Partner ID

        • Property user_id (string)

          User ID

        • Property sha_body_content (string)

          SHA Body Content

        • Property hmac_ss (string)

          Routeone HMACSS

        • Property api_hash (string)

          Hashing key for the RouteOne

        • Property hmac_id (string)

          RouteOne HMAC Id

        • Property webhook_url (string)

          Webhook URL

      • Added property bmw_deals (object)

        Credit Application & Contract Management Configuration

        • Property token_url (string)

          Token Url for the Credit & Contract Management

        • Property webhook_url (string)

          Webhook Url for the Credit & Contract Management

        • Property api_url (string)

          API Url for the Credit & Contract Management

        • Property client_id (string)

          Client ID for the Credit & Contract Management

        • Property client_secret (string)

          Client Secret for the Credit & Contract Management

      • Changed property cdk (object)

        CDK configuration

        • Deleted property elead_customer_api (object)

          Cdk Elead Customer Api configuration

      • Changed property dealer_track (object)

        Dealer Track Configuration

        • Added property multilender (object)

          Configuration settings for integrating with DealerTrack's multi-lender platform.

          • Property token_url (string)

            DealerTrack Authentication Token URL

          • Property api_url (string)

            DealerTrack API Base URL

          • Property client_secret (string)

            DealerTrack Client Secret

          • Property api_key (string)

            DealerTrack API Key

          • Property client_id (string)

            DealerTrack Client ID

          • Property webhook_url (string)

            Webhook url for credit application decision response

          • Property source_partner_id (string)

            DealerTrack Source Partner ID

        • Added property lender_info (object)

          Configuration settings for DealerTrack's Lender Info.

          • Property api_url (string)

            DealerTrack Lender Info API URL

          • Property partner_dealer_id (string)

            Partner Dealer ID

          • Property client_id (string)

            Client ID

          • Property client_secret (string)

            Client Secret

          • Property token_url (string)

            Token URL

    • Changed property price_management_system (object)

      Configuration for pricing management services

      • Changed property bmw_pricing (object)

        BMW pricing API integration

        New optional properties:

        • grant_type

        • scope

        • trace_id

        • Deleted property grant_type (string)

          Pricing token grant type

        • Deleted property scope (string)

          Pricing authentication scope

        • Deleted property trace_id (string)

          Pricing Trace Id

    • Changed property fni_products (object)

      Configuration for the FnI Products

      • Changed property product_service (object)

        Warranty aggregator API configurations

        New optional properties:

        • scope

        • Deleted property scope (string)

          Scope for warranty aggregator api

    • Changed property license_verification (object)

      Configuration for License Verification

      • Added property facephi (object)

        FacePhi account integration

        • Property base_url (string)

          FacePhi Base API url (Sandbox or Production)

        • Property api_key (string)

          FacePhi Credentials - Authorization to access the API

POST /configuration

Request:

Changed content type : application/json

  • Added property ascent_configuration (object)

  • Added property inventory_server (object)

  • Added property inventory_management (object)

  • Changed property credit_application (object)

    • Changed property transunion (object)

      TransUnion Configuration

      • Changed property certificate_file (string)

        The user needs to convert its .p12 format certificate file into a base 64 string format by following these steps:

        Send a request to the configuration endpoint of Hubex.

        • A certificate file will be generated on the AWS cloud, and the response will display certificate_file as certificate_5555.
        • Now you can utilize the TransUnion third-party service.

  • Changed property dealer_management_system (object)

    • Added property routeone (object)

      RouteOne Configuration

    • Added property bmw_deals (object)

      Credit Application & Contract Management Configuration

    • Changed property cdk (object)

      CDK configuration

      • Deleted property elead_customer_api (object)

        Cdk Elead Customer Api configuration

    • Changed property dealer_track (object)

      Dealer Track Configuration

      • Added property multilender (object)

        Configuration settings for integrating with DealerTrack's multi-lender platform.

      • Added property lender_info (object)

        Configuration settings for DealerTrack's Lender Info.

  • Changed property price_management_system (object)

    • Changed property bmw_pricing (object)

      BMW pricing API integration

      New optional properties:

      • grant_type

      • scope

      • trace_id

      • Deleted property grant_type (string)

        Pricing token grant type

      • Deleted property scope (string)

        Pricing authentication scope

      • Deleted property trace_id (string)

        Pricing Trace Id

  • Changed property fni_products (object)

    • Changed property product_service (object)

      Warranty aggregator API configurations

      New optional properties:

      • scope

      • Deleted property scope (string)

        Scope for warranty aggregator api

  • Changed property license_verification (object)

    • Added property facephi (object)

      FacePhi account integration

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property ascent_configuration (object)

      Ascent Configurations

    • Added property inventory_server (object)

      Configuration for inventory server

    • Added property inventory_management (object)

      Configuration for the Inventory Management services

    • Changed property credit_application (object)

      Configuration for Credit Application

      • Changed property transunion (object)

        TransUnion Configuration

        • Changed property certificate_file (string)

          The user needs to convert its .p12 format certificate file into a base 64 string format by following these steps:

          Send a request to the configuration endpoint of Hubex.

          • A certificate file will be generated on the AWS cloud, and the response will display certificate_file as certificate_5555.
          • Now you can utilize the TransUnion third-party service.

    • Changed property dealer_management_system (object)

      Configuration for dms

      • Added property routeone (object)

        RouteOne Configuration

      • Added property bmw_deals (object)

        Credit Application & Contract Management Configuration

      • Changed property cdk (object)

        CDK configuration

        • Deleted property elead_customer_api (object)

          Cdk Elead Customer Api configuration

      • Changed property dealer_track (object)

        Dealer Track Configuration

        • Added property multilender (object)

          Configuration settings for integrating with DealerTrack's multi-lender platform.

        • Added property lender_info (object)

          Configuration settings for DealerTrack's Lender Info.

    • Changed property price_management_system (object)

      Configuration for pricing management services

      • Changed property bmw_pricing (object)

        BMW pricing API integration

        New optional properties:

        • grant_type

        • scope

        • trace_id

        • Deleted property grant_type (string)

          Pricing token grant type

        • Deleted property scope (string)

          Pricing authentication scope

        • Deleted property trace_id (string)

          Pricing Trace Id

    • Changed property fni_products (object)

      Configuration for the FnI Products

      • Changed property product_service (object)

        Warranty aggregator API configurations

        New optional properties:

        • scope

        • Deleted property scope (string)

          Scope for warranty aggregator api

    • Changed property license_verification (object)

      Configuration for License Verification

      • Added property facephi (object)

        FacePhi account integration

PATCH /configuration

Request:

Changed content type : application/json

  • Added property ascent_configuration (object)

  • Added property inventory_server (object)

  • Added property inventory_management (object)

  • Changed property credit_application (object)

    • Changed property transunion (object)

      TransUnion Configuration

      • Changed property certificate_file (string)

        The user needs to convert its .p12 format certificate file into a base 64 string format by following these steps:

        Send a request to the configuration endpoint of Hubex.

        • A certificate file will be generated on the AWS cloud, and the response will display certificate_file as certificate_5555.
        • Now you can utilize the TransUnion third-party service.

  • Changed property dealer_management_system (object)

    • Added property routeone (object)

      RouteOne Configuration

    • Added property bmw_deals (object)

      Credit Application & Contract Management Configuration

    • Changed property cdk (object)

      CDK configuration

      • Deleted property elead_customer_api (object)

        Cdk Elead Customer Api configuration

    • Changed property dealer_track (object)

      Dealer Track Configuration

      • Added property multilender (object)

        Configuration settings for integrating with DealerTrack's multi-lender platform.

      • Added property lender_info (object)

        Configuration settings for DealerTrack's Lender Info.

  • Changed property price_management_system (object)

    • Changed property bmw_pricing (object)

      BMW pricing API integration

      New optional properties:

      • grant_type

      • scope

      • trace_id

      • Deleted property grant_type (string)

        Pricing token grant type

      • Deleted property scope (string)

        Pricing authentication scope

      • Deleted property trace_id (string)

        Pricing Trace Id

  • Changed property fni_products (object)

    • Changed property product_service (object)

      Warranty aggregator API configurations

      New optional properties:

      • scope

      • Deleted property scope (string)

        Scope for warranty aggregator api

  • Changed property license_verification (object)

    • Added property facephi (object)

      FacePhi account integration

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property ascent_configuration (object)

      Ascent Configurations

    • Added property inventory_server (object)

      Configuration for inventory server

    • Added property inventory_management (object)

      Configuration for the Inventory Management services

    • Changed property credit_application (object)

      Configuration for Credit Application

      • Changed property transunion (object)

        TransUnion Configuration

        • Changed property certificate_file (string)

          The user needs to convert its .p12 format certificate file into a base 64 string format by following these steps:

          Send a request to the configuration endpoint of Hubex.

          • A certificate file will be generated on the AWS cloud, and the response will display certificate_file as certificate_5555.
          • Now you can utilize the TransUnion third-party service.

    • Changed property dealer_management_system (object)

      Configuration for dms

      • Added property routeone (object)

        RouteOne Configuration

      • Added property bmw_deals (object)

        Credit Application & Contract Management Configuration

      • Changed property cdk (object)

        CDK configuration

        • Deleted property elead_customer_api (object)

          Cdk Elead Customer Api configuration

      • Changed property dealer_track (object)

        Dealer Track Configuration

        • Added property multilender (object)

          Configuration settings for integrating with DealerTrack's multi-lender platform.

        • Added property lender_info (object)

          Configuration settings for DealerTrack's Lender Info.

    • Changed property price_management_system (object)

      Configuration for pricing management services

      • Changed property bmw_pricing (object)

        BMW pricing API integration

        New optional properties:

        • grant_type

        • scope

        • trace_id

        • Deleted property grant_type (string)

          Pricing token grant type

        • Deleted property scope (string)

          Pricing authentication scope

        • Deleted property trace_id (string)

          Pricing Trace Id

    • Changed property fni_products (object)

      Configuration for the FnI Products

      • Changed property product_service (object)

        Warranty aggregator API configurations

        New optional properties:

        • scope

        • Deleted property scope (string)

          Scope for warranty aggregator api

    • Changed property license_verification (object)

      Configuration for License Verification

      • Added property facephi (object)

        FacePhi account integration

GET /dms/deals

Parameters:

Changed: x-service-provider in header

Provider Name

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /dms/deals

Parameters:

Changed: x-service-provider in header

Provider Name

Request:

Changed content type : application/json

  • Added property assets_quantity (integer)

    Number of vehicles attached to a deal

  • Added property community_property_disclosure_indicator (boolean)

    Boolean flag to acknowledge that the Applicant(s) reside in the community property state, in which, property acquired by either spouse during a marriage is considered community property, belonging to both partners of the marriage. This is applicable only if we have a coApplicant on the Credit Application. If primary applicant is from Community property state and application is individual (i.e. no coApplicant provided) then Community Property disclosure is mandatory. If any of the applicants is from Community property state and application is joint and coApplicant's relationship is 'Spouse' then either Community Property state disclosure or regulationBIndicator is mandatory.

  • Added property comments (string)

    Comments to allow communication or pass through notes between transactions and systems.

  • Added property dealer_code (string)

    Broker Name

  • Added property extra_data (array)

    Object to contain the custom messages and targeted communication between partners.

    Items (object):

    • Property name (string)

      The name (identifier) of the extra data sent across the Partners.

    • Property value (object)

      The description of the name (identifier) in the extra data sent.

  • Added property privacy_notice_indicator (boolean)

    Boolean flag to identify if the Customer/(s) are notified on how the Dealership is going to use the Customer's personal information.

  • Added property program_code (string)

    Program Code

  • Added property program_name (string)

    Program Name

  • Added property partner_source (string)

    Used by the partners to communicate and identify the origin of the Credit Applications.

  • Added property regulation_b_indicator (boolean)

    Boolean flag to identify if the Applicant and Co-applicant are willing to apply for Joint Credit.

  • Added property send_adf_email (boolean)

    Boolean flag to indicate whether an ADF email will be sent out by third party

  • Added property target_platforms (array)

    Object to contain the information related to the destination platforms or the Partner related information

    Items (object):

    • Property id (string)

      ID representing the destination platform for the request.

    • Property party_id (string)

      A unique identifier assigned to the Partner's Dealers that is understood by the Partner Platform. It could be sourcePartnerDealerId, Branch Id, etc.

  • Added property unique_req_id (string)

    Calling system will pass this id

  • Added property is_resubmit (boolean)

    This parameter is used to run the deal resubmission flow

  • Added property resubmit (object)

    • Property credit_application_id (string)

      The credit application id need for the resubmission of deal

    • Property deal_id (string)

      The deal id need for the resubmission of deal

  • Changed property deal_type (string)

    An enumeration.

    Added enum values:

    • Finance
    • Lease
    • Ballon

  • Changed property finance (object)

    • Added property rental_modes (object)

    • Added property VAT_payment_methods (object)

    • Added property VAT_collection_rental_number (integer)

    • Added property VAT_status (string)

    • Added property monthly_use_tax (number)

    • Added property adjusted_capitalized_cost (number)

    • Added property taxable_accessories (integer)

      Total of Taxable Accessories

    • Added property non_taxable_accessories (integer)

      Total of Non Taxable Accessories

    • Changed property government_fees (string -> number)

    • Changed property rebate (string -> number)

    • Changed property credit_life_ins (string -> number)

    • Changed property acquisition_fees (string -> number)

    • Changed property warranty (string -> number)

    • Changed property gap (string -> number)

    • Changed property accident_health_ins (string -> number)

    • Changed property front_end_fees (string -> number)

    • Changed property msrp (string -> number)

    • Changed property used_car_book (number -> string)

    • Changed property other_fees (string -> number)

    • Changed property mileage (string -> integer)

  • Changed property tradeIns (array)

    Changed items (object):

    • Added property payoff_amount (number)

      Trade-In Payoff Amount

    • Added property gross_allowance (number)

      Trade-In Gross Allowance

    • Added property allowance_amount (number)

      Trade-In Allowance Amount

    • Added property offer_amount (number)

      TradeIn Offer Amount

    • Added property gross_amount (number)

      TradeIn Gross Amount

    • Added property trade_amount (number)

      TradeIn Trade amount

    • Added property lease_balance_amount (number)

      TradeIn Balance Amount

    • Added property trade_net_financed_amount (number)

      TradeIn Net Financed Amount

    • Added property net_financed_amount (number)

      TradeIn Net FInanced Amount

    • Deleted property trade_in_payoff_amount (number)

      Trade-In Payoff Amount

    • Deleted property trade_in_allowance_amount (number)

      Trade-In Allowance Amount

    • Changed property asset (object)

      Trade-In asset details

      • Added property chrome_style_id (string)

        Chrome Style ID for the Vehicle

      • Added property vehicle_book_condition (string)

        Vahicle Conditon for the selected wholesale book source.

      • Added property monthly_payment (number)

    • Changed property lien_holder (object)

      Trade-In lien holder details

      • Changed property address (object)

        Lien holder address details

        • Changed property country (string -> string)

          An enumeration.

  • Changed property assets (array)

    Changed items (object):

    • Added property is_garage (boolean)

      Boolean to indicate that vehicle has garbage address or not

    • Added property odo_actual_vehicle_mileage (boolean)

    • Added property odo_reflects_exc_mech_limits (boolean)

    • Added property odo_reflects_vehicle_mileage (boolean)

    • Added property prior_use (string)

      Odo Exceed prior use

    • Added property vehicle_use (object)

      Vehicle primary use type

      Enum values:

      • PersonalFamilyOrHousehold
      • BusinessCommercial
      • Agriculture

    • Added property collateral_type (string)

      An enumeration.

      Enum values:

      • Auto
      • LightTruck
      • MediumTruck
      • ConversationVan
      • Other

    • Added property wholesale_amount (integer)

    • Added property intended_use (string)

      An enumeration.

      Enum values:

      • Business
      • Agricultural
      • Hazardous
      • Local
      • Interstate
      • Intermediate
      • Personal

    • Added property vehicle_sold_as_is (boolean)

      Indicates whether the vehicle is being sold without any modifications

    • Added property vehicle_address (object)

      Vehicle Address. Required if is_garage is true

      • Property line1 (string)

        Address Line 1

      • Property line2 (string)

        Address Line 2

      • Property is_current (boolean)

      • Property city (string)

        City Name

      • Property state (string)

        Two-Letter 'State' Abbreviations

      • Property county (string)

        County Name

      • Property country (string)

        An enumeration.

        Enum value:

        • US

      • Property zip_code (string)

        ZIP CODE of given address

      • Property resident_type (string)

        Type of Resident

      • Property address_type (string)

        An enumeration.

        Enum values:

        • CURRENT
        • PREVIOUS
        • GARAGE
        • ALTERNATE_GARAGE
        • BILLING

      • Property period_of_residence (object)

        • Property duration (integer)

        • Property type (string)

          An enumeration.

          Enum values:

          • YEARS
          • MONTHS

      • Property address_classification (string)

        An enumeration.

        Enum values:

        • BUSINESS
        • RESIDENCE

    • Changed property stock_type (string)

      An enumeration.

      Added enum value:

      • Other

    • Changed property sub_type (string)

      An enumeration.

      Added enum value:

      • Other

    • Changed property condition (string -> string)

      An enumeration.

  • Changed property customers (array)

    Customers details

    Changed items (object):

    • Added property enterprise_type (object)

      Indicates the type of enterprise level for business customers. Note: this is only for business customers only

      Enum values:

      • CORPORATION
      • LLC
      • PARTNERSHIP
      • PROPRIETOR

    • Added property monthly_residence_amount (integer)

      Customer monthly residence monthly

    • Added property other_monthly_income_frequency (string)

    • Added property sic_code (string)

      SIC Code

    • Added property bank (object)

      • Property bank_name (string)

        Customer bank name

      • Property account_title (string)

        Customer bank account title

      • Property account_number (string)

        Customer bank account number

      • Property account_type (object)

        Customer bank account type

        Enum values:

        • 1
        • 2

      • Property routing_number (string)

        Customer bank routing number

      • Property phone_number (string)

        Customer bank phone number

      • Property paper_less_request (boolean)

        Customer interest in paperless solution

      • Property payment_start_month (integer)

        Start month of payment

    • Added property display_name (string)

      Display Name. Required if the customer type is business

    • Added property business_type_desc (string)

      Business Description. Required if the customer type is business

    • Added property ownership_percent (number)

      Principal Ownership Percentage. Required if the customer type is business

    • Added property monthly_gross_profit (integer)

      Principal Monthly Gross Profit. Required if the customer type is business

    • Added property relationship_desc (string)

      Operator Relationship Description. Required if the customer type is business

    • Added property operator_type (object)

      Operator Type. Required if the customer type is business

      Enum values:

      • Director
      • Operator

    • Added property education_level (object)

      Education Level Code

      Enum values:

      • CollegeOrUniGrad
      • TwoYearCollegeOrUniGrad
      • SpecialtyTraining
      • SomeCollege
      • HighSchoolGrad
      • NotHighSchoolGrad
      • Unknown

    • Added property other_income (object)

      Other Income Source

      • Property amount (integer)

      • Property currency (string)

      • Property description (string)

      • Property frequency (object)

        Interval at which income is received

        Enum values:

        • Weekly
        • BiWeekly
        • Semimonthly
        • Monthly
        • Yearly

      • Property source (object)

        Source for income

        Enum values:

        • AidForDependentChildren
        • ChildSupport
        • CostOfLivingAllowance
        • Disability
        • FamilySubsistenceSupplementalAllowance
        • HousingAllowances
        • MilitaryBasicAllowance
        • MunicipalBondInterest
        • OtherNonTaxableSourcesIncome
        • Other
        • PublicAssistance
        • RailroadPension
        • SecondEmployer
        • SocialSecurityBenefits
        • WorkmanCompensation

    • Added property prev_income (object)

      Previous income amount

    • Changed property customer_type (string)

      An enumeration.

      Added enum values:

      • PRINCIPAL
      • OPERATOR

    • Changed property email (string -> string)

      Email ID of Customer

    • Changed property housing_status (string -> string)

      An enumeration.

    • Changed property relationship (string)

      The relationship between the various customer roles

    • Changed property consent_given (string -> boolean)

    • Changed property driving_license (object)

      Driving License Details of Customer

      • Added property id_type (object)

        License to be used for identification

        Enum values:

        • DriverLicense
        • StateId

      • Added property id_number (string)

        ID number to be used for identification

      • Added property expiration_date (string)

        Date of expiration

      • Added property issue_date (string)

        Date of issue

      • Changed property issuing_state (string)

        State Name of the id Issuer

    • Changed property addresses (array)

      Address Details

      Changed items (object):

      • Added property address_classification (string)

        An enumeration.

      • Changed property country (string -> string)

        An enumeration.

    • Changed property spouse (object)

      Customer Spouse Details

      • Added property suffix (string)

        Suffix for the Spouse

      • Changed property address (object)

        Address Details of Spouse

        • Added property address_classification (string)

          An enumeration.

        • Changed property country (string -> string)

          An enumeration.

        • Changed property address_type (string)

          An enumeration.

          Added enum value:

          • ALTERNATE_GARAGE

    • Changed property insurance (array)

      Insurance Details of Customer

      Changed items (object):

      • Changed property agency_details (object)

        Insurance Agency Details

        • Changed property address (object)

          Insurance Agency Address Details

          • Added property address_classification (string)

            An enumeration.

          • Changed property country (string -> string)

            An enumeration.

    • Changed property employment (array)

      Employment Details

      Changed items (object):

      • Changed property status (string -> string)

        An enumeration.

      • Changed property address (object)

        Employment Address Details

        • Added property address_classification (string)

          An enumeration.

        • Changed property country (string -> string)

          An enumeration.

      • Changed property period_of_employment (object)

        Period of employment

        • Changed property duration (integer -> number)

  • Changed property deal_payment (object)

    New required properties:

    • contract_date
    • contract_term_mileage

    New optional properties:

    • lender

    • Added property add_ons (array)

      Items (object):

      • Property name (string)

        Description of the add-on item

      • Property price (number)

        Price of the add-on item

    • Added property number_of_advance_rentals (integer)

    • Added property vendor_id (string)

    • Added property contract_date (string)

      The date when the contract is signed by the customer

    • Added property contract_term_mileage (integer)

      The Term Mileage for the contract

    • Added property rental_frequency (string)

      The frequency by which we are charging the customer

    • Added property payment_mode (string)

      The payment mode selected for the payment

    • Added property include_freight_and_pdi (boolean)

    • Added property pay_terms (integer)

    • Added property max_unused_purchase_distance (integer)

    • Added property disposition_fee (object)

      • Property monthly_payment_factor (number)

        Disposition monthly payment factor

      • Property fixed_amount (number)

        Disposition fee fixed amount

    • Changed property deal_payment_total (object)

      • Added property monthly_payment (number)

      • Added property gross_cap_cost (number)

      • Added property adjusted_cap_cost (number)

      • Added property tax_on_cap_cost_reduction (number)

      • Added property monthly_sales_use_tax (number)

      • Added property use_tax_rate (number)

      • Added property total_sales_use_tax (number)

      • Added property monthly_depreciation (number)

      • Added property due_amount_at_signing (number)

      • Added property trade_in_balance (integer)

      • Added property total_monthly_payments (number)

      • Added property asset_residual_value (number)

      • Added property residual_value (number)

      • Added property base_residual_type (integer)

      • Added property excess_mileage_rate (number)

      • Deleted property monthly_payments (number)

      • Deleted property approved_amount (number)

    • Changed property fees (array)

      Changed items (object):

      • Added property state_code (string)

    • Changed property payment_option (object)

      • Changed property type (string)

        An enumeration.

        Added enum value:

        • CHEQUE

    • Changed property tax_details (object)

      • Changed property taxes (array)

        Changed items (object):

        • Changed property type (string)

          An enumeration.

          Added enum value:

          • CAPITAL_COST_REDUCTION_TAX

    • Changed property fnis (array)

      Changed items (object):

      New optional properties:

      • disclosure_type

      • term

      • Added property price (number)

        Amount of the add-on item

      • Added property fee_type_code (string)

        Third party fee type code of FnI product

      • Added property provider_code (object)

        FnI provider code

        Enum values:

        • ESC
        • MPU
        • Others

      • Changed property plan (object)

        • Added property description (string)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property credit_application_id (string)

    • Added property unique_req_id (string)

    • Added property body (array)

      Items (object):

      • Property lender_id (string)

      • Property submitted (boolean)

      • Property description (string)

GET /leads/search

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property items (array)

      A collection of customer search results

      Changed items (object):

      • Changed property vehicles (array)

        List of vehicles

        Changed items (object):

        • Changed property status (string)

          An enumeration.

          Added enum value:

          • PO Removed enum value:

          • Po

POST /mitek/verify-license

Request:

Changed content type : application/json

  • Changed property customer_id (string)

    Customer provided identifier that will be returned in named CustomerReferenceId field within the body of any subsequent responses. CustomerReferenceId is a random number that will be returned in response.

  • Changed property max_retries (integer)

    Maximum number of retries in configure hours for a customer. If limit is exhausted, the system only allows license verification after 24 hours.

Version 1.1.82Version 1.1.80