API Keys

Create and Manage your API Keys

API Keys

Overview

An API Key is a code used to identify, authenticate, and authorize a user. PAVE Capture API calls require authentication in the form of an HMAC-SHA256 message hash as a header within the request.

AuthenticationPAVE Automated Inspection API

Creating a new API Key

Step 1: Click 'Create New Key' to get started

Creating a new API Key is a simple process. Click on the the 'Create New Key' button to get started.

Step 2: Add required information and customizations and click 'Create'

Then, provide the information on the Create New Key modal and then click 'Create'.

Reference Guide

The following is a reference guide for the information requested on the Create New Key modal

Reference Guide

The following is a reference guide for the information requested on the Create New Key modal

Criteria	Definition
Key Name	Give your API Key a unique name
License	Chose between one or more licenses assigned to your account
Live	Toggle ON to generate a Live API Key Toggle OFF to generate a Test API Key
Default Theme	Choose between Lite and Pro Capture UI Themes
PII Mask	Toggle ON to remove or blur Personal Identifiable Information such as VIN, Address, License plates on photos, on the results HTML page and the CR.
Redirect URL	This is a custom URL to which the user will be redirected once a PAVE Capture is completed
Capture Options	Customize the Pave Capture experience by skipping Interior and/or Odometer captures, and by including Disclosures and/or Announcements
Customize Capture SMS	Customize the SMS message that is sent to the user along with the capture link URL
Customize Results SMS	Customize the SMS message that is sent to the user along with the capture results URL
Wear and Tear Estimates	Add wear and tear estimates to the Results Page and the Condition Report PDF
Expired Sessions	Set a time frame after which an incomplete session generated by this key will expire and not functional anymore

Skip Odometer When 'Skip Odometer' is selected, the Odometer image is skipped and a Manual Odometer reading is required instead, during a PAVE session.

List of API Keys

All existing API Keys are visible in the Dashboard, API Key view

All existing and new API Keys are visible in the API Key view on the Dashboard. This view includes the Key Name, API Key, and the API Secret Key.