# 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**](https://en.wikipedia.org/wiki/Hash-based_message_authentication_code) message hash as a header within the request.

{% embed url="<https://docs.paveapi.com/integrations/developer-docs/authentication>" %}

#### Creating a new API Key

<figure><img src="https://1101422075-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkOe4CeRywX7c1q79rw84%2Fuploads%2FmbVna2Uu9DKvWBTDbGwg%2FAPI%20Keys%20(1).png?alt=media&#x26;token=3b75ac2b-9dd6-4f61-9cec-acdd16b22256" alt=""><figcaption><p>Step 1: Click 'Create New Key' to get started</p></figcaption></figure>

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

<figure><img src="https://1101422075-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkOe4CeRywX7c1q79rw84%2Fuploads%2FEu02Vjlf3Vdwk8XEhxFn%2FScreenshot%202023-03-31%20170037%20(1).png?alt=media&#x26;token=24a2645b-5e09-4e76-87a7-d052dee0f845" alt=""><figcaption><p>Step 2: Add required information and customizations and click 'Create'</p></figcaption></figure>

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**                 | <p></p><p>Chose between one or more licenses assigned to your account</p>                                                                          |
| **Live**                    | <p>Toggle ON to generate a Live API Key<br>Toggle OFF to generate a Test API Key</p>                                                               |
| **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                                    |

{% hint style="info" %}
**Skip Odometer** When 'Skip Odometer' is selected, the Odometer image is skipped and a Manual Odometer reading is required instead, during a PAVE session.&#x20;
{% endhint %}

#### List of API Keys

<figure><img src="https://1101422075-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkOe4CeRywX7c1q79rw84%2Fuploads%2Fe5iR4k49lliDjnmKXfIz%2FAPI%20Keys%203%20(1).png?alt=media&#x26;token=97f915b4-a153-4472-8835-09142aee4888" alt=""><figcaption><p>All existing API Keys are visible in the Dashboard, API Key view</p></figcaption></figure>

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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guides.pave.ai/branch-dashboard/user-feature-walkthrough/developer-tools/api-keys.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.