API Docs Version 1.1.82
What's New
GET /hubex/health1
Health
POST /hubex/set-dealer
Register Dealer
POST /hubex/set-dealer-fni-products
Set Dealer F&I Products
POST /hubex/get-dealer-products
Get Dealer Products
POST /hubex/get-providers
Get Providers
POST /hubex/get-provider-products
Get Provider Products
POST /hubex/get-dealer-surcharges
Get Dealer Surcharges
POST /hubex/get-rates
Get Rates
POST /hubex/get-preview-form
Get Preview Form
POST /hubex/get-filled-form
Get Filled Form
POST /hubex/set-deal
Set Deal
POST /hubex/void-contract
Void Contract
POST /hubex/get-service-products
Warranty & Protection products
POST /hubex/mitek/verify-license
Verify License
POST /hubex/identity/verify-identity
Verify Identity
POST /hubex/tradein/get-tradein-years
Years
POST /hubex/tradein/get-tradein-makes
Makes
POST /hubex/tradein/get-tradein-models
Models
POST /hubex/tradein/get-tradein-modelyears
Model Years
POST /hubex/tradein/get-tradein-trims
Trims
POST /hubex/tradein/get-tradein-allOptions
Options
POST /hubex/tradein/get-tradein-vehicle
Vehicle Detail
POST /hubex/tradein/get-tradein-vehiclevalue
Vehicle Value
POST /hubex/tradein/get-tradein-decodevin
Decode VIN
POST /hubex/payment/setup-intents
Create a setup intent
GET /hubex/payment/payment-methods/all/{customer_id}
Get all payment methods of a customer
PATCH /hubex/payment/payment-methods/{customer_id}/{payment_method_id}
Update a payment method
DELETE /hubex/payment/payment-methods/{payment_method_id}
Delete a payment method
POST /hubex/payment/payment-intents
Create a new payment intent
GET /hubex/payment/payment-intents/{payment_intent_id}
Get a payment intent
DELETE /hubex/payment/payment-intents/{payment_intent_id}/cancel
Cancel a payment intent
GET /hubex/payment/refunds
List all refunds
POST /hubex/payment/refunds
Create a new refund.
GET /hubex/payment/refunds/{refund_id}
Get a refund
DELETE /hubex/payment/refunds/{refund_id}/cancel
Cancel a refund
POST /hubex/payment/link/token
Create a Link token
POST /hubex/payment/bank-accounts
Create a bank account
POST /hubex/payment/accounts
Create account
GET /hubex/payment/accounts/{account_id}
Get account by id
POST /hubex/payment/account-links
Create account link
GET /hubex/payment/customers
List all customers
POST /hubex/payment/customers
Create a customer
GET /hubex/payment/customers/{customer_id}
Get a customer
PATCH /hubex/payment/customers/{customer_id}
Update a customer
GET /hubex/payment/balance-transactions/{customer_id}
List all customer balance transactions
POST /hubex/payment/balance-transactions/{customer_id}
Create a customer balance transaction
GET /hubex/payment/balance-transactions/{customer_id}/{balance_transaction_id}
Get a customer balance transaction
PATCH /hubex/payment/balance-transactions/{customer_id}/{balance_transaction_id}
Update a customer balance transaction
GET /hubex/payment/products
List all products
POST /hubex/payment/products
Create a product
GET /hubex/payment/products/search
Search Products
GET /hubex/payment/products/{product_id}
Get a product
DELETE /hubex/payment/products/{product_id}
Delete a product
PATCH /hubex/payment/products/{product_id}
Update a product
GET /hubex/payment/prices
Get price list
POST /hubex/payment/prices
Create a price
GET /hubex/payment/prices/{price_id}
Get a price
PATCH /hubex/payment/prices/{price_id}
Update a price
GET /hubex/payment/invoices
List all invoices
POST /hubex/payment/invoices
Create Invoice
GET /hubex/payment/invoices/search
Search Invoices
GET /hubex/payment/invoices/search-by-query
Search Invoices
POST /hubex/payment/invoices/search-by-metadata
Search Invoices by metadata
GET /hubex/payment/invoices/{invoice_id}
Get Invoice
DELETE /hubex/payment/invoices/{invoice_id}
Delete Invoice
PATCH /hubex/payment/invoices/{invoice_id}
Update Invoice
POST /hubex/payment/invoices/{invoice_id}/send
Send Invoice
POST /hubex/payment/invoices/upcoming
Upcoming Invoices
POST /hubex/payment/invoices/{invoice_id}/void
Void an Invoice
POST /hubex/payment/credit-notes/preview
Preview a credit note
GET /hubex/payment/credit-notes
List credit notes
POST /hubex/payment/credit-notes
Create a credit note
GET /hubex/payment/invoice/credit-notes
Get invoice credit notes
GET /hubex/payment/invoice-items
List All Invoice Items
POST /hubex/payment/invoice-items
Create Invoice Items
DELETE /hubex/payment/invoice-items
Delete Invoice Items
POST /hubex/payment/invoice-items/{invoice_item_id}
Update Invoice Items
POST /hubex/notification/send-notification
Send Notification
GET /hubex/notification/otp-configuration
Get OTP Configuration
POST /hubex/notification/otp-configuration
Add OTP Configuration
DELETE /hubex/notification/otp-configuration
Delete OTP Configuration
PATCH /hubex/notification/send-otp
Send OTP
POST /hubex/notification/verify-otp
Verify OTP
POST /hubex/notification/send-sms
Send SMS
POST /hubex/notification/send-email
Send Email
POST /hubex/notification/verify-emails
Verify Email Address
POST /hubex/fraud-identification/email-auth-score
API to validate customer PII data
GET /hubex/configuration
Get Hubex Configuration
POST /hubex/configuration
Create Hubex Configurations
DELETE /hubex/configuration
Delete Hubex Configurations
PATCH /hubex/configuration
Update Hubex Configurations
POST /hubex/credit/check
Credit Check
GET /hubex/events/{event_id}
Get an Event
GET /hubex/events
Get List of All Events
POST /hubex/dms/customers
Create Customer
GET /hubex/dms/customers/search
Search Customer
GET /hubex/dms/customers/{customer_id}
Get Customer
PUT /hubex/dms/customers/{customer_id}
Update Customer
GET /hubex/dms/deals
Get Deals
POST /hubex/dms/deals
Create Deal
POST /hubex/dms/deals/convert-to-contract
Convert to Contract
GET /hubex/dms/get-lenders
Get Lender Information.
POST /hubex/pricing/get-pricing
Get Pricing
POST /hubex/pricing/get-fni-monthly-payment-impact
Get FnI Monthly Payment Impact
POST /hubex/tax/get-taxes
Get State Fee Taxes by Geo Location
GET /hubex/api/verify-address/{address}
Address Verification
POST /hubex/contract
Contract Management
POST /hubex/tagging/send-tagging
Digital Retail Tagging
POST /hubex/insurance/create
Create a new insurance quote
GET /hubex/insurance/status/{transaction_id}
Retrieve the insurance status
POST /hubex/e-sign
Sends mail to recipients with the documents
GET /hubex/e-sign/consent
Gets the consent url
GET /hubex/e-sign/status/{signature_id}
Retrieves the status of the specified envelope
GET /hubex/company-lookup/search
Search company information
GET /hubex/company-lookup/retrieve-directors-info/{company_id}
Retrieve directors info
GET /hubex/address-lookup/search
Utilizes the Search API for different ordnance survey providers
POST /hubex/program/get-programs
Get Programs
POST /hubex/leads
Create Lead
GET /hubex/leads/search
Search Leads
GET /hubex/leads/{customer_id}
Get Elead Customer
PATCH /hubex/leads/{customer_id}
Update Lead
POST /hubex/document/get-document
Get document
POST /hubex/document/upload-document
Upload document
PUT /hubex/inventory
Update Vehicle Inventory
POST /hubex/inventory
Create Vehicle Inventory
POST /hubex/get-inventory
Get Vehicle Inventory
POST /hubex/get-inventory-filter
Get Inventory Filter
GET /hubex/ams/offices
Get Offices
GET /hubex/ams/sales-persons
Get Sales Persons
GET /hubex/ams/assets
Get Assets
GET /hubex/ams/calculation/config
Get Calculation Config
POST /hubex/ams/submit-proposal
Create and Submit Proposal
GET /hubex/ams/proposal-updates
Get Proposal Update
POST /hubex/payoff-quotes
PayOff Quotes
GET /hubex/sentry-debug
Trigger Error
GET /hubex/api-version
Get Hubex API Version
GET /hubex/health
Health
GET /hubex/product
Get Products
GET /hubex/product/{product_id}
Get Product By Id
PUT /hubex/product/{product_id}
Update Product
DELETE /hubex/product/{product_id}
Delete Product
POST /hubex/customer/without-charge
Create Customer Non Pay
POST /hubex/customer/with-charge
Create Customer Pay
POST /hubex/customer/without-card
Create Customer Without Card
POST /hubex/customer/payment-method
Create Payment Method Of Existing Customer
POST /hubex/customer/{customer_id}/retrieve-source
Retrieve Source
DELETE /hubex/customer/delete/{stripe_customer_id}
Delete Stripe Customer
POST /hubex/stripe/subscription
Create Subscription
GET /hubex/stripe/subscription/{subscription_id}
Get Subscription
PUT /hubex/stripe/subscription/{subscription_id}
Update Subscription
POST /hubex/stripe/subscription/cancel/{subscription_id}
Delete Subscription
POST /hubex/email/send-otp-email
Send Otp Email
POST /hubex/email/send-order-credit-email
Send Order Credit Email
POST /hubex/email/send-order-quotation-email
Send Order Quotation Email
POST /hubex/email/send-verify-email
Send Verify Email
POST /hubex/email/send-forgot-password-email
Send Forgot Password Email
POST /hubex/email/on-boarding-email-to-existing-users
Send On Boarding Email To Existing Users
POST /hubex/email/send-update-password-email
Send Update Password Email
POST /hubex/email/send-profile-creation-email
Send Profile Creation Email
POST /hubex/email/send-welcome-letter-email
Welcome
POST /hubex/email/send-subscription-consumption-email
Subscription Consumption Email
POST /hubex/email/send-unsubscribed-confirmation-email
Unsubscribed Product
POST /hubex/email/send-successful-unsubscribtion-email
Unsubscribed Successfully
POST /hubex/email/send-waitlist-email
Waitlist Email
POST /hubex/email/send-payment-verification-email
Payment Verification Email
POST /hubex/email/send-payment-declined-email
Declined Payment Email
POST /hubex/email/send-payment-proof-acknowledgement-email
Payment Proof Acknowledgement Email
POST /hubex/email/send-subscription-trial-email
Subscription Subscription Email
POST /hubex/email/send-feedback-submission-email
Feedback Submission
POST /hubex/email/send-payment-invoice-email
Payment Invoice Email
POST /hubex/email/send-abandoned-cart-email
Abandoned Cart Email
POST /hubex/email/ondemand-package-details
Ondemand Package
POST /hubex/email/contact-us
Contact Us
POST /hubex/email/flex-user-creation
Flex Contact Us
POST /hubex/email/send-email-to-customer
Send Customer On Board Welcome Email
POST /hubex/email/send-admin-bank-transfer
Send Admin Bank Transfer Admin Email
POST /hubex/email/send-request-bank-transfer
Send Admin Bank Transfer Request Email
POST /hubex/email/payment-declined
Email Payment Declined
POST /hubex/email/send-subscription-termination-email
Send Access Termination Email
POST /hubex/email/send-pending-payment-proof-email
Send Pending Payment Proof Email
POST /hubex/email/bank-transfer-pending-approval-queue-email
Bank Transfer Pending Approval Queue Email
POST /hubex/email/send-feedback-email
Send Feedback
GET /hubex/payment-method/{stripe_payment_method_id}
Get Payment Method By Id
POST /hubex/customer/payment-method/{stripe_customer_id}
Get Payment Method By Customer Id
POST /hubex/customer/payment-method/attach/{stripe_customer_id}
Attach New Payment Method
POST /hubex/customer/payment-method/detach/{stripe_payment_method_id}
Detach Payment Method
POST /hubex/customer/payment-method/default/{stripe_customer_id}/{stripe_payment_method_id}
Change Default Payment Method
POST /hubex/customer/add-invoice-item
Add Item To Invoice
POST /hubex/customer/create-payment-intent
Create Customer Payment Intent
GET /hubex/invoices/{customer_id}
Get Invoices
GET /hubex/customer/payment-intent/{customer_id}
Get Payment Intent
GET /hubex/version
Version
POST /hubex/deal-status
Update Deal Status
What's Deleted
GET /health1
Health
POST /set-dealer
Register Dealer
POST /set-dealer-fni-products
Set Dealer F&I Products
POST /get-dealer-products
Get Dealer Products
POST /get-providers
Get Providers
POST /get-provider-products
Get Provider Products
POST /get-rates
Get Rates
POST /get-preview-form
Get Preview Form
POST /get-filled-form
Get Filled Form
POST /set-deal
Set Deal
POST /void-contract
Void Contract
POST /get-service-products
Warranty & Protection products
POST /mitek/verify-license
Verify License
POST /identity/verify-identity
Verify Identity
POST /tradein/get-tradein-years
Years
POST /tradein/get-tradein-makes
Makes
POST /tradein/get-tradein-models
Models
POST /tradein/get-tradein-modelyears
Model Years
POST /tradein/get-tradein-trims
Trims
POST /tradein/get-tradein-allOptions
Options
POST /tradein/get-tradein-vehicle
Vehicle Detail
POST /tradein/get-tradein-vehiclevalue
Vehicle Value
POST /tradein/get-tradein-decodevin
Decode VIN
POST /payment/setup-intents
Create a setup intent
GET /payment/payment-methods/all/{customer_id}
Get all payment methods of a customer
PATCH /payment/payment-methods/{customer_id}/{payment_method_id}
Update a payment method
DELETE /payment/payment-methods/{payment_method_id}
Delete a payment method
POST /payment/payment-intents
Create a new payment intent
GET /payment/payment-intents/{payment_intent_id}
Get a payment intent
DELETE /payment/payment-intents/{payment_intent_id}/cancel
Cancel a payment intent
GET /payment/refunds
List all refunds
POST /payment/refunds
Create a new refund.
GET /payment/refunds/{refund_id}
Get a refund
DELETE /payment/refunds/{refund_id}/cancel
Cancel a refund
POST /payment/link/token
Create a Link token
POST /payment/bank-accounts
Create a bank account
POST /payment/accounts
Create account
GET /payment/accounts/{account_id}
Get account by id
POST /payment/account-links
Create account link
GET /payment/customers
List all customers
POST /payment/customers
Create a customer
GET /payment/customers/{customer_id}
Get a customer
PATCH /payment/customers/{customer_id}
Update a customer
GET /payment/balance-transactions/{customer_id}
List all customer balance transactions
POST /payment/balance-transactions/{customer_id}
Create a customer balance transaction
GET /payment/balance-transactions/{customer_id}/{balance_transaction_id}
Get a customer balance transaction
PATCH /payment/balance-transactions/{customer_id}/{balance_transaction_id}
Update a customer balance transaction
GET /payment/products
List all products
POST /payment/products
Create a product
GET /payment/products/search
Search Products
GET /payment/products/{product_id}
Get a product
DELETE /payment/products/{product_id}
Delete a product
PATCH /payment/products/{product_id}
Update a product
GET /payment/prices
Get price list
POST /payment/prices
Create a price
GET /payment/prices/{price_id}
Get a price
PATCH /payment/prices/{price_id}
Update a price
GET /payment/invoices
List all invoices
POST /payment/invoices
Create Invoice
GET /payment/invoices/search
Search Invoices
GET /payment/invoices/search-by-query
Search Invoices
POST /payment/invoices/search-by-metadata
Search Invoices by metadata
GET /payment/invoices/{invoice_id}
Get Invoice
DELETE /payment/invoices/{invoice_id}
Delete Invoice
PATCH /payment/invoices/{invoice_id}
Update Invoice
POST /payment/invoices/{invoice_id}/send
Send Invoice
POST /payment/invoices/upcoming
Upcoming Invoices
POST /payment/invoices/{invoice_id}/void
Void an Invoice
POST /payment/credit-notes/preview
Preview a credit note
GET /payment/credit-notes
List credit notes
POST /payment/credit-notes
Create a credit note
GET /payment/invoice/credit-notes
Get invoice credit notes
GET /payment/invoice-items
List All Invoice Items
POST /payment/invoice-items
Create Invoice Items
DELETE /payment/invoice-items
Delete Invoice Items
POST /payment/invoice-items/{invoice_item_id}
Update Invoice Items
POST /notification/send-notification
Send Notification
GET /notification/otp-configuration
Get OTP Configuration
POST /notification/otp-configuration
Add OTP Configuration
DELETE /notification/otp-configuration
Delete OTP Configuration
PATCH /notification/send-otp
Send OTP
POST /notification/verify-otp
Verify OTP
POST /notification/send-sms
Send SMS
POST /notification/send-email
Send Email
POST /notification/verify-emails
Verify Email Address
POST /fraud-identification/email-auth-score
API to validate customer PII data
GET /configuration
Get Hubex Configuration
POST /configuration
Create Hubex Configurations
DELETE /configuration
Delete Hubex Configurations
PATCH /configuration
Update Hubex Configurations
POST /credit/check
Credit Check
GET /events/{event_id}
Get an Event
GET /events
Get List of All Events
POST /dms/customers
Create Customer
GET /dms/customers/search
Search Customer
GET /dms/customers/{customer_id}
Get Customer
PUT /dms/customers/{customer_id}
Update Customer
GET /dms/deals
Get Deals
POST /dms/deals
Create Deal
POST /dms/deals/convert-to-contract
Convert to Contract
GET /dms/get-lenders
Get Lender Information.
POST /pricing/get-pricing
Get Pricing
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
GET /api/verify-address/{address}
Address Verification
POST /contract
Contract Management
POST /tagging/send-tagging
Digital Retail Tagging
POST /insurance/create
Create a new insurance quote
GET /insurance/status/{transaction_id}
Retrieve the insurance status
POST /e-sign
Sends mail to recipients with the documents
GET /e-sign/consent
Gets the consent url
GET /e-sign/status/{signature_id}
Retrieves the status of the specified envelope
GET /company-lookup/search
Search company information
GET /company-lookup/retrieve-directors-info/{company_id}
Retrieve directors info
GET /address-lookup/search
Utilizes the Search API for different ordnance survey providers
POST /program/get-programs
Get Programs
POST /leads
Create Lead
GET /leads/search
Search Leads
GET /leads/{customer_id}
Get Elead Customer
PATCH /leads/{customer_id}
Update Lead
POST /document/get-document
Get document
PUT /inventory
Update Vehicle Inventory
POST /inventory
Create Vehicle Inventory
POST /get-inventory
Get Vehicle Inventory
GET /api-version
Get Hubex API Version
GET /product
Get Products
GET /product/{product_id}
Get Product By Id
PUT /product/{product_id}
Update Product
DELETE /product/{product_id}
Delete Product
POST /customer/without-charge
Create Customer Non Pay
POST /customer/with-charge
Create Customer Pay
POST /customer/without-card
Create Customer Without Card
POST /customer/payment-method
Create Payment Method Of Existing Customer
POST /customer/{customer_id}/retrieve-source
Retrieve Source
DELETE /customer/delete/{stripe_customer_id}
Delete Stripe Customer
POST /stripe/subscription
Create Subscription
GET /stripe/subscription/{subscription_id}
Get Subscription
PUT /stripe/subscription/{subscription_id}
Update Subscription
POST /stripe/subscription/cancel/{subscription_id}
Delete Subscription
POST /email/send-otp-email
Send Otp Email
POST /email/send-order-credit-email
Send Order Credit Email
POST /email/send-order-quotation-email
Send Order Quotation Email
POST /email/send-verify-email
Send Verify Email
POST /email/send-forgot-password-email
Send Forgot Password Email
POST /email/on-boarding-email-to-existing-users
Send On Boarding Email To Existing Users
POST /email/send-update-password-email
Send Update Password Email
POST /email/send-profile-creation-email
Send Profile Creation Email
POST /email/send-welcome-letter-email
Welcome
POST /email/send-subscription-consumption-email
Subscription Consumption Email
POST /email/send-unsubscribed-confirmation-email
Unsubscribed Product
POST /email/send-successful-unsubscribtion-email
Unsubscribed Successfully
POST /email/send-waitlist-email
Waitlist Email
POST /email/send-payment-verification-email
Payment Verification Email
POST /email/send-payment-declined-email
Declined Payment Email
POST /email/send-payment-proof-acknowledgement-email
Payment Proof Acknowledgement Email
POST /email/send-subscription-trial-email
Subscription Subscription Email
POST /email/send-feedback-submission-email
Feedback Submission
POST /email/send-payment-invoice-email
Payment Invoice Email
POST /email/send-abandoned-cart-email
Abandoned Cart Email
POST /email/ondemand-package-details
Ondemand Package
POST /email/contact-us
Contact Us
POST /email/flex-user-creation
Flex Contact Us
POST /email/send-email-to-customer
Send Customer On Board Welcome Email
POST /email/send-admin-bank-transfer
Send Admin Bank Transfer Admin Email
POST /email/send-request-bank-transfer
Send Admin Bank Transfer Request Email
POST /email/payment-declined
Email Payment Declined
POST /email/send-subscription-termination-email
Send Access Termination Email
POST /email/send-pending-payment-proof-email
Send Pending Payment Proof Email
POST /email/bank-transfer-pending-approval-queue-email
Bank Transfer Pending Approval Queue Email
POST /email/send-feedback-email
Send Feedback
GET /payment-method/{stripe_payment_method_id}
Get Payment Method By Id
POST /customer/payment-method/{stripe_customer_id}
Get Payment Method By Customer Id
POST /customer/payment-method/attach/{stripe_customer_id}
Attach New Payment Method
POST /customer/payment-method/detach/{stripe_payment_method_id}
Detach Payment Method
POST /customer/payment-method/default/{stripe_customer_id}/{stripe_payment_method_id}
Change Default Payment Method
POST /customer/add-invoice-item
Add Item To Invoice
POST /customer/create-payment-intent
Create Customer Payment Intent
GET /invoices/{customer_id}
Get Invoices
GET /customer/payment-intent/{customer_id}
Get Payment Intent
POST /deal-status
Update Deal Status