API Docs Version 1.1.23

What's Deleted

POST /void-contract

What's Changed

POST /set-dealer

Request:

Changed content type : application/json

New required properties:

action

POST /get-providers

Return Type:

Changed response : 200 OK

Changed content type : application/json
- Changed property providers (object)
  
  Provider Information
  - Changed property provider (array -> object)
    
    List of Providers

POST /get-provider-products

Return Type:

Changed response : 200 OK

Changed content type : application/json
- Changed property products (object)
  
  Provider Products Information
  - Changed property product (array -> object)
    
    List of Provider Products

POST /get-dealer-products

Return Type:

Changed response : 200 OK

Changed content type : application/json
- Changed property dealer_products (object)
  
  Dealer Products Information
  - Changed property dealer_product (array -> object)
    
    List of Dealer Products

POST /tradein/get-tradein-years

Return Type:

Changed response : 201 Created

Changed content type : application/json

POST /tradein/get-tradein-makes

Request:

Changed content type : application/json

Changed property filter (object)

If not specified, all makes will be returned
- Added property start_year (integer)
- Added property end_year (integer)
- Added property category_id (integer)

Return Type:

Changed response : 201 Created

Changed content type : application/json

POST /tradein/get-tradein-models

Request:

Changed content type : application/json

Changed property filter (object)

If not specified, all models will be returned
- Added property start_year (integer)
- Added property end_year (integer)
- Added property category_id (integer)
- Added property year (integer)

Return Type:

Changed response : 201 Created

Changed content type : application/json

POST /tradein/get-tradein-modelyears

Return Type:

Changed response : 201 Created

Changed content type : application/json

POST /tradein/get-tradein-trims

Return Type:

Changed response : 201 Created

Changed content type : application/json

POST /tradein/get-tradein-allOptions

Return Type:

Changed response : 201 Created

Changed content type : application/json

POST /tradein/get-tradein-vehicle

Return Type:

Changed response : 201 Created

Changed content type : application/json

POST /tradein/get-tradein-vehiclevalue

Request:

Changed content type : application/json

Added property start_year (integer)
Added property end_year (integer)
Added property model_id (integer)

Return Type:

Changed response : 201 Created

Changed content type : application/json

POST /tradein/get-tradein-decodevin

Return Type:

Changed response : 201 Created

Changed content type : application/json

POST /payment/setup-intents

Parameters:

Added: x-api-version in header

Request:

Changed content type : application/json

Changed property customer_id (string)

Customer id from profile or third-party customer id

GET /payment/payment-methods/all/{customer_id}

Parameters:

Added: x-api-version in header

PATCH /payment/payment-methods/{customer_id}/{payment_method_id}

Parameters:

Added: x-api-version in header

POST /payment/payment-intents

Request:

Changed content type : application/json

Added property check_balance (boolean)

Check the bank account's balance

POST /payment/bank-accounts

Parameters:

Added: x-api-version in header

Request:

Changed content type : application/json

Changed property customer_id (string)

Customer id from profile or third-party customer id

POST /fraud-identification/email-auth-score

Parameters:

Added: x-api-version in header

POST /configuration

Request:

Changed content type : application/json

Changed property payment (object)

Configuration for the Payment
- Changed property nuvei (object)
  
  Nuvei Configuration
  - Changed property api_url (string -> string)
    
    Nuvei Base API url (Sandbox or Production)
Changed property account_verification (object)

Configuration for the Account Verification
- Changed property plaid (object)
  
  Plaid Configuration
  - Changed property api_url (string -> string)
    
    Plaid Base API url (Sandbox or Production)
Changed property fraud_identification (object)

Configuration for Fraud Identification
- Changed property socure (object)
  
  Socure Integration
  - Changed property api_url (string -> string)
    
    Socure Base API URL (Sandbox or Production)
- Changed property innovis (object)
  
  Innovis Integration
  - Changed property api_url (string -> string)
    
    Innovis Base API URL (Sandbox or Production)
Changed property credit_application (object)

Configuration for Credit Application
- Changed property equifax (object)
  
  Equifax configurations
  - Changed property base_url (string -> string)
    
    Equifax Base API url (Sandbox or Production)
- Changed property experian (object)
  
  Experian Configurations
  - Changed property base_url (string -> string)
    
    Experian Base API url (Sandbox or Production)
- Changed property transunion (object)
  
  TransUnion Configuration
  
  New required properties:
  - base_url
  - system_id
  - system_password
  New optional properties:
  - systemId
  - systemPassword
  - url
  - Added property base_url (string)
    
    TransUnion Base API url (Sandbox or Production)
  - Added property system_id (string)
    
    System ID
  - Added property system_password (string)
    
    System Password
  - Deleted property url (string)
    
    API URL
  - Deleted property systemId (string)
    
    System ID
  - Deleted property systemPassword (string)
    
    System Password
  - Changed property subscriber (object)
    
    TransUnion Subscriber
    
    New required properties:
    - industry_code
    - inquiry_subscriber_prefix_code
    - member_code
    New optional properties:
    - industryCode
    - inquirySubscriberPrefixCode
    - memberCode
    - Added property industry_code (string)
      
      Industry Code
    - Added property member_code (string)
      
      Member Code
    - Added property inquiry_subscriber_prefix_code (string)
      
      Inquiry Subscriber Prefix Code
    - Deleted property industryCode (string)
      
      Industry Code
    - Deleted property memberCode (string)
      
      Member Code
    - Deleted property inquirySubscriberPrefixCode (string)
      
      Inquiry Subscriber Prefix Code
Changed property vehicle_valuation (object)

Configuration for Vehicle Valuation
- Changed property kbb (object)
  
  KBB Integration
  - Changed property base_url (string -> string)
    
    KBB Base API url (Sandbox or Production)
- Changed property jdpower (object)
  
  JD Power Integration
  - Changed property base_url (string -> string)
    
    JD Power Base API url (Sandbox or Production)
Changed property license_verification (object)

Configuration for License Verification
- Changed property mitek (object)
  
  Mitek account integration
  - Changed property mitek_account (object)
    
    Mitek Account
    - Changed property identity_api_base_url (string -> string)
      
      Mitek Identity Base API url (Sandbox or Production)
    - Changed property manual_api_base_url (string -> string)
      
      Mitek Manual Base API url (Sandbox or Production)

PATCH /configuration

Request:

Changed content type : application/json

New optional properties:

configuration

Added property payment (object)

Configuration for the Payment
- Property stripe (object)
  
  Stripe Payment Configuration
  - Property api_key (string)
    
    Stripe API key to connect with stripe
  - Property api_version (string)
    
    Stripe version to use
- Property nuvei (object)
  
  Nuvei Configuration
  - Property merchant_id (string)
    
    The merchant ID provided by Nuvei.
  - Property merchant_site_id (string)
    
    The merchant site ID provided by Nuvei.
  - Property merchant_secret_key (string)
    
    The merchant secret key provided by Nuvei
  - Property api_url (string)
    
    Nuvei Base API url (Sandbox or Production)
- Property payment_service (string)
  
  An enumeration.
  
  Enum values:
  - Stripe
  - Nuvei
Added property account_verification (object)

Configuration for the Account Verification
- Property plaid (object)
  
  Plaid Configuration
  - Property client_secret (string)
    
    Plaid API secret
  - Property client_id (string)
    
    Plaid API client_id
  - Property client_app_name (string)
    
    The name of your application, as it should be displayed in Link.
  - Property client_webhook (string)
    
    The destination URL to receive any webhooks from Plaid.
  - Property api_url (string)
    
    Plaid Base API url (Sandbox or Production)
  - Property api_version (string)
    
    Plaid API version
- Property account_verification_service (string)
  
  An enumeration.
  
  Enum value:
  - Plaid
Added property fraud_identification (object)

Configuration for Fraud Identification
- Property fraud_identification_service (string)
  
  An enumeration.
  
  Enum values:
  - Socure
  - Innovis
- Property socure (object)
  
  Socure Integration
  - Property api_key (string)
    
    Socure Api Key
  - Property api_url (string)
    
    Socure Base API URL (Sandbox or Production)
- Property innovis (object)
  
  Innovis Integration
  - Property api_key (string)
    
    Innovis Api Key
  - Property api_url (string)
    
    Innovis Base API URL (Sandbox or Production)
  - Property innovis_customer_id (string)
    
    Innovis Customer Id
- Property fraud_ttl (integer)
  
  Fraud Identification TTL
Added property license_verification (object)

Configuration for License Verification
- Property license_verification_service (string)
  
  An enumeration.
  
  Enum values:
  - MiTek
  - IdNow
- Property mitek (object)
  
  Mitek account integration
  - Property mitek_account (object)
    
    Mitek Account
    - Property identity_api_base_url (string)
      
      Mitek Identity Base API url (Sandbox or Production)
    - Property identity_client_id (string)
      
      Mitek Identity Client Id
    - Property identity_client_secret (string)
      
      Mitek Identity Client Secret
    - Property manual_api_base_url (string)
      
      Mitek Manual Base API url (Sandbox or Production)
    - Property manual_client_id (string)
      
      Mitek Manual Client Id
    - Property manual_client_secret (string)
      
      Mitek Manual Client Secret
    - Property retries_duration (integer)
      
      Mitek retries duration
  - Property verification_matrix (object)
    
    Mitek Verification Matrix
    - Property verifications (array)
      
      Verification List for Mitek Account
      
      Items (object):
      - Property mitek_verification_type (integer)
        
        Mitek Verification Type
      - Property mitek_judgement (string)
        
        Mitek Judgment description
      - Property action (string)
        
        Action for the Mitek account
- Property idnow (object)
  
  IdNow account integration
Added property credit_application (object)

Configuration for Credit Application
- Property credit_ttl (integer)
  
  Credit Application TTL
- Property credit_service (string)
  
  Customer Default Credit Service
- Property equifax (object)
  
  Equifax configurations
  - Property base_url (string)
    
    Equifax Base API url (Sandbox or Production)
  - Property username (string)
    
    Client ID
  - Property password (string)
    
    Client Secret
- Property experian (object)
  
  Experian Configurations
  - Property base_url (string)
    
    Experian Base API url (Sandbox or Production)
  - Property username (string)
    
    Experian Credentials - Email Address
  - Property password (string)
    
    Experian Credentials - Password
  - Property client_id (string)
    
    Experian Credentials - Client Id
  - Property client_secret (string)
    
    Experian Credentials - Client Secret
  - Property client_reference_id (string)
    
    Experian Credentials - Client Reference Id
- Property transunion (object)
  
  TransUnion Configuration
  - Property base_url (string)
    
    TransUnion Base API url (Sandbox or Production)
  - Property system_id (string)
    
    System ID
  - Property system_password (string)
    
    System Password
  - Property subscriber (object)
    
    TransUnion Subscriber
    - Property industry_code (string)
      
      Industry Code
    - Property member_code (string)
      
      Member Code
    - Property inquiry_subscriber_prefix_code (string)
      
      Inquiry Subscriber Prefix Code
    - Property password (string)
      
      Subscriber Password
Added property vehicle_valuation (object)

Configuration for Vehicle Valuation
- Property vehicle_valuation_service (string)
  
  An enumeration.
  
  Enum values:
  - KBB
  - JDPower
- Property kbb (object)
  
  KBB Integration
  - Property base_url (string)
    
    KBB Base API url (Sandbox or Production)
  - Property api_key (string)
    
    KBB Api Key
- Property jdpower (object)
  
  JD Power Integration
  - Property base_url (string)
    
    JD Power Base API url (Sandbox or Production)
  - Property username (string)
    
    JD Power User Name
  - Property password (string)
    
    JD Power User Password
Deleted property configuration (object)

Hubex Configuration Updation Model

POST /credit/check

Parameters:

Added: x-api-version in header

POST /email/send-forgot-password-email

Request:

Changed content type : application/json

Added property is_admin (boolean)

POST /email/on-boarding-email-to-existing-users

Request:

Changed content type : application/json

Added property is_admin (boolean)

POST /mitek/verify-license

Parameters:

Added: x-api-version in header

Version 1.1.24 Version 1.1.22