API Docs Version 1.1.51

What's New

POST /get-service-products

Warranty & Protection products

GET /payment/accounts/{account_id}

Get account by id

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

POST /payment/create-payment

Create payment through single API

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/inventory

Get Vehicle Inventory

PUT /dms/inventory

Update Vehicle Inventory

POST /dms/inventory

Create Vehicle Inventory

GET /dms/deals

Get Deals

POST /dms/deals

Create Deal

POST /dms/leads

Create Lead

GET /dms/leads/search

Search Leads

GET /dms/leads/{customer_id}

Get Elead Customer

PATCH /dms/leads/{customer_id}

Update Lead

POST /pricing/get-pricing

Get Pricing

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 /insurance/create

Create a new insurance quote

GET /insurance/status/{transaction_id}

Retrieve the insurance status

POST /quick-sign

Sends mail to recipients with the documents

GET /quick-sign/consent

Gets the consent url

GET /quick-sign/status/{signature_id}

Retrieves the status of the specified envelope

GET /payment/invoice-items

List All Invoice Items

What's Deleted

POST /bucket/upload-file

S3 Bucket for objects upload on aws

DELETE /bucket/delete-file/{key_name}

Delete S3 Bucket object

What's Changed

POST /set-dealer

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /get-dealer-products

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /get-providers

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /get-provider-products

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /void-contract

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /set-deal

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /tradein/get-tradein-years

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 201 Created

Successful Response

• Changed content type : application/json

POST /tradein/get-tradein-makes

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 201 Created

Successful Response

• Changed content type : application/json

POST /tradein/get-tradein-models

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 201 Created

Successful Response

• Changed content type : application/json

POST /tradein/get-tradein-modelyears

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 201 Created

Successful Response

• Changed content type : application/json

POST /tradein/get-tradein-trims

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 201 Created

Successful Response

• Changed content type : application/json

POST /tradein/get-tradein-allOptions

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 201 Created

Successful Response

• Changed content type : application/json

POST /tradein/get-tradein-vehicle

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 201 Created

Successful Response

• Changed content type : application/json

POST /tradein/get-tradein-decodevin

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 201 Created

Successful Response

• Changed content type : application/json

POST /payment/setup-intents

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

Changed content type : application/json

• Changed property customer_id (string)

  The unique id of the customer from the third-party service.

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property payment_method_options (string -> object)

    Payment-method-specific configuration for this SetupIntent

  • Changed property payment_method_types (string -> array)

    The list of payment method types that this SetupIntent is allowed to set up. If this is not provided, defaults to [“card”]. Valid payment method types include: acss_debit, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, card_present, ideal, link, sepa_debit, sofort, and us_bank_account.

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

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

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

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

DELETE /payment/payment-methods/{payment_method_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/payment-intents

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Payment service to use

Request:

Changed content type : application/json

• Changed property confirm (boolean)

  Set to true to attempt to confirm Payment Method immediately. This parameter defaults to false.

• Changed property customer (string)

  ID of the Customer, this payment method belongs to, if one exists.

• Changed property payment_method (string)

  ID of the payment method (e.g. Card).

• Changed property capture_method (string -> string)

  An enumeration.

• Changed property payment_method_type (string)

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

• Changed property return_url (string)

  The Return Url is essential for providing a seamless user experience during the payment process. After making a payment, users expect to be redirected to a confirmation page or a receipt page to acknowledge the successful completion of their transaction.

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/payment-intents/{payment_intent_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

DELETE /payment/payment-intents/{payment_intent_id}/cancel

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/refunds

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/refunds

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

Changed content type : application/json

• Changed property reason (string)

  An enumeration.

  Added enum value:

  • Other

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/refunds/{refund_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

DELETE /payment/refunds/{refund_id}/cancel

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/link/token

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/bank-accounts

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

Changed content type : application/json

• Changed property customer_id (string)

  Customer id from profile or third-party customer i

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/accounts

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

Changed content type : application/json

• Changed property email (string)

  The email address of the account holder. This is only to make the account easier to identify to you. Payment service only emails Custom accounts with your consent.

• Changed property default_currency (string)

  Three-letter ISO currency code representing the default currency for the account. This must be a currency that payment service supports in the account’s country.

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/account-links

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/balance-transactions/{customer_id}

Parameters:

Deleted: ending_before in query

Deleted: starting_after in query

Deleted: limit in query

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

New content type : application/json

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /payment/balance-transactions/{customer_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/balance-transactions/{customer_id}/{balance_transaction_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

PATCH /payment/balance-transactions/{customer_id}/{balance_transaction_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/products

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/products

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/products/search

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/products/{product_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

DELETE /payment/products/{product_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

PATCH /payment/products/{product_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/prices

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/prices

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/prices/{price_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

PATCH /payment/prices/{price_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/invoices/search

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/invoices/search-by-query

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/invoices/search-by-metadata

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/invoices/{invoice_id}/send

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/invoices/{invoice_id}/void

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/charges

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/invoice/credit-notes

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/invoice-items

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

DELETE /payment/invoice-items

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/invoice-items/{invoice_item_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /fraud-identification/email-auth-score

Parameters:

Added: x-dealer-code in header

Changed: x-service-provider in header

Fraud service to use

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 400 Bad Request

Bad Request

New response : 403 Forbidden

Forbidden

New response : 404 Not Found

Not Found

New response : 429 null

Too Many Requests

New response : 500 Internal Server Error

Internal Server Error

New response : 501 Not Implemented

Not Implemented

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

GET /events/{event_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /events

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /set-dealer-fni-products

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /tradein/get-tradein-vehiclevalue

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

Vehicle valuation service to use

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 201 Created

Successful Response

• Changed content type : application/json

GET /payment/invoices

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/invoices

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

Changed content type : application/json

• Changed property auto_advance (boolean)

  Controls whether payment service will perform automatic collection of the invoice

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

GET /payment/invoices/{invoice_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

DELETE /payment/invoices/{invoice_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

PATCH /payment/invoices/{invoice_id}

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

Changed content type : application/json

• Changed property auto_advance (boolean)

  Controls whether payment service will perform automatic collection of the invoice

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/invoices/upcoming

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /payment/credit-notes/preview

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

Changed content type : application/json

• Changed property out_of_band_amount (integer)

  The integer amount in cents representing the amount that is credited outside of Payment service.

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /payment/credit-notes

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /payment/credit-notes

Parameters:

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

Changed content type : application/json

• Changed property out_of_band_amount (integer)

  The integer amount in cents representing the amount that is credited outside of Payment service.

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /credit/check

Parameters:

Changed: x-service-provider in header

Credit service to use

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Request:

Changed content type : application/json

• Changed property date_of_birth (string)

  i.e. 2023-03-20

POST /email/send-otp-email

Request:

Changed content type : application/json

• Deleted property full_name (string)

GET /api/verify-address/{address}

Get Verified Address

Parameters:

Added: x-dealer-code in header

Added: x-service-provider in header

Address Verification Service to use

Deleted: x-google-api-key in header

Google API key will be used for address verification

Return Type:

New response : 404 Not Found

Zero Results

New response : 429 null

Over Query Limit

New response : 403 Forbidden

Request Denied

New response : 400 Bad Request

Invalid Request

New response : 500 Internal Server Error

Unknown Error

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /get-rates

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property rates (object)

    • Changed property rate (object)

      • Changed property coverages (object)

        • Changed property coverage (object)

          • Changed property product_type (integer -> string)

            Product Type.

          • Changed property term_months (integer -> string)

            Term months

          • Changed property term_miles (integer -> string)

            Term miles.

POST /get-preview-form

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Request:

Changed content type : application/json

• Changed property customer (object)

  Customer details.

  • Added property phonenumber (string)

    Phone number of the customer city.

  • Changed property businessphonenumber (string)

    Business phone number of the customer city.

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

POST /get-filled-form

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-service-provider in header

FnI Products service to use

Added: x-dealer-code in header

Deleted: x-pen-user-name in header

Deleted: x-pen-user-secret in header

Deleted: x-pen-user-token in header

Request:

Changed content type : application/json

• Changed property customer (object)

  Customer details.

  • Added property phonenumber (string)

    Phone number of the customer city.

  • Changed property businessphonenumber (string)

    Business phone number of the customer city.

Return Type:

New response : 403 Forbidden

Forbidden

New response : 429 null

Too Many Requests

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property signatures (object)

    • Changed property signature (object)

      • Changed property page_numbers (object)

        • Added property int (object)

        • Deleted property page_number (object)

GET /configuration

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-dealer-code in header

Added: x-service-provider in header

Configuration service provider to receive

Return Type:

New response : 400 Bad Request

Bad Request

New response : 403 Forbidden

Forbidden

New response : 404 Not Found

Not Found

New response : 422 Unprocessable Entity

Unprocessable Entity

New response : 429 null

Too Many Requests

New response : 500 Internal Server Error

Internal Server Error

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

DELETE /configuration

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-dealer-code in header

Added: x-service-provider in header

Configuration service provider to receive

Return Type:

New response : 400 Bad Request

Bad Request

New response : 403 Forbidden

Forbidden

New response : 404 Not Found

Not Found

New response : 422 Unprocessable Entity

Unprocessable Entity

New response : 429 null

Too Many Requests

New response : 500 Internal Server Error

Internal Server Error

New response : 501 Not Implemented

Not Implemented

POST /configuration

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-dealer-code in header

Request:

Changed content type : application/json

• Added property price_management_system (object)

  • Property bmw_pricing (object)

    BMW pricing API integration

    • Property token_url (string)

      Authentication Token API URL

    • Property api_url (string)

      Pricing API Base URL

    • Property client_id (string)

      Pricing Client ID

    • Property estimator_client_id (string)

      Estimator Pricing Client ID

    • Property client_secret (string)

      Pricing client secret

    • Property estimator_client_secret (string)

      Estimator Pricing client secret

    • Property grant_type (string)

      Pricing token grant type

    • Property scope (string)

      Pricing authentication scope

    • Property trace_id (string)

      Pricing Trace Id

  • Property market_scan (object)

    Market Scan integration

    • Property api_url (string)

      Market Scan API base URL

    • Property partner_id (string)

      Market Scan Partner Id

    • Property account_number (string)

      Market Scan Account Id

• Added property address_verification (object)

  • Property google (object)

    Google Address Verification API Configuration

    • Property api_key (string)

      API Key for the address verification service

• Added property fni_products (object)

  • Property pen (object)

    • Property api_url (string)

      PEN API URL

    • Property user_name (string)

      PEN Username

    • Property password (string)

      PEN Password

    • Property user_token (string)

      PEN User Token

  • Property product_service (object)

    Warranty aggregator API configurations

    • Property token_url (string)

      Token Url for warranty aggregator api

    • Property api_url (string)

      API Url for warranty aggregator api

    • Property client_id (string)

      Client Id for warranty aggregator api

    • Property client_secret (string)

      Client secret for warranty aggregator api

    • Property scope (string)

      Scope for warranty aggregator api

• Added property co_browsing (object)

  • Property upscope (object)

    Upscope provider script key

    • Property script_key (string)

      Upscope Script key

• Added property insurance_management (object)

  • Property way (object)

    Way Configuration

    • Property api_url (string)

      Base API URL

    • Property auth_token (string)

      Authentication token

    • Property webhook_url (string)

      Webhook URL

• Added property quick_sign (object)

  • Property docusign (object)

    Docusign Configuration

    • Property oauth_hostname (string)

      API hostname for envelopes

    • Property api_base_url (string)

      Docusign API base URL

    • Property api_version (string)

      Docusign API version

    • Property user_id (string)

      Docusign User ID

    • Property account_id (string)

      Docusign Account ID

    • Property client_id (string)

      Docusign Client ID

    • Property webhook_url (string)

      Your webhook URL for where you want the response

    • Property jwt_oauth_hostname (string)

      Docusign JWT OAUTH hostname

    • Property secret_key (string)

      Docusign RSA Private Key in base64 encoding

• Added property inventory_server (object)

  • Property shift_digital (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

• Changed property account_verification (object)

• Changed property fraud_identification (object)

• Changed property credit_application (object)

• Changed property vehicle_valuation (object)

• Changed property dealer_management_system (object)

  • Added property sd_leads (object)

    Shift Digital Configuration

    • Property elead (object)

      • Property api_url (string)

  • Added property dealer_track (object)

    Dealer Track Configuration

    • 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 dms (object)

      Configuration settings for DealerTrack's DMS.

      • Property api_url (string)

      • Property username (string)

      • Property password (string)

      • Property enterprise_code (string)

      • Property company_number (string)

      • Property host (string)

        Dealer Track host URL

• Changed property license_verification (object)

  • Deleted property facephi (object)

    FacePhi account integration

• Changed property payment (object)

Return Type:

New response : 400 Bad Request

Bad Request

New response : 403 Forbidden

Forbidden

New response : 404 Not Found

Not Found

New response : 429 null

Too Many Requests

New response : 500 Internal Server Error

Internal Server Error

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

PATCH /configuration

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

Added: x-dealer-code in header

Request:

Changed content type : application/json

• Added property price_management_system (object)

• Added property address_verification (object)

• Added property fni_products (object)

• Added property co_browsing (object)

• Added property insurance_management (object)

• Added property quick_sign (object)

• Added property inventory_server (object)

• Changed property account_verification (object)

• Changed property fraud_identification (object)

• Changed property credit_application (object)

• Changed property vehicle_valuation (object)

• Changed property dealer_management_system (object)

  • Added property sd_leads (object)

    Shift Digital Configuration

  • Added property dealer_track (object)

    Dealer Track Configuration

• Changed property license_verification (object)

  • Deleted property facephi (object)

    FacePhi account integration

• Changed property payment (object)

Return Type:

New response : 400 Bad Request

Bad Request

New response : 403 Forbidden

Forbidden

New response : 404 Not Found

Not Found

New response : 429 null

Too Many Requests

New response : 500 Internal Server Error

Internal Server Error

New response : 501 Not Implemented

Not Implemented

Changed response : 200 OK

Successful Response

• Changed content type : application/json

Changed response : 422 Unprocessable Entity

Unprocessable Entity

• Changed content type : application/json

  New required properties:

  • detail

  • Changed property detail (array -> object)

    Error details

POST /mitek/verify-license

Parameters:

Added: x-dealer-code in header

Changed: x-api-version in header

API version. e.g 1.1 or 1.0

Changed: x-service-provider in header

License verification service to use