# PAVE Automated Inspection API ## PAVE Automated Inspection API - [PAVE OpenAPI Overview](https://docs.paveapi.com/master.md) - [How PAVE Works](https://docs.paveapi.com/how-pave-works.md) - [Capture Link](https://docs.paveapi.com/how-pave-works/capture-link.md): Send a PAVE capture link by text to anyone. - [Guided Capture](https://docs.paveapi.com/how-pave-works/guided-capture.md): PAVE's guided capture makes it easy for anyone to capture the required photos. - [Customer Disclosures](https://docs.paveapi.com/how-pave-works/customer-disclosures.md): The user can quickly answer all your required disclosures and announcements once they're done taking the photos. - [Identified Vehicle Information](https://docs.paveapi.com/how-pave-works/identified-vehicle-information.md) - [Captured Photos](https://docs.paveapi.com/how-pave-works/captured-photos.md): Get 13 HD and 4K Photos on Every Appraisal - [Text Notifications](https://docs.paveapi.com/how-pave-works/text-notifications.md): Be Engaged The Second They Become Re-engaged. - [Inspection Results](https://docs.paveapi.com/how-pave-works/inspection-results.md) - [Condition Report (PDF)](https://docs.paveapi.com/how-pave-works/condition-report-pdf.md) - [Detected Damages](https://docs.paveapi.com/how-pave-works/detected-damages.md) - [Grading](https://docs.paveapi.com/how-pave-works/grading.md): Comprehensive Vehicle Grading with PAVE - [Languages](https://docs.paveapi.com/how-pave-works/languages.md): Introduction to PAVE's User Interface Language Internationalization - [Accuracy & Limitations](https://docs.paveapi.com/how-pave-works/accuracy-and-limitations.md): PAVE is designed to match the accuracy of in-person inspections, though some limitations in damage detection may occur when relying solely on analyzing photos. - [Developer Docs](https://docs.paveapi.com/integrations/developer-docs.md) - [Authentication](https://docs.paveapi.com/integrations/developer-docs/authentication.md): The PAVE Capture API requires authentication for all API calls, which is achieved through the use of an HMAC-SHA256 message hash as a header within the request. - [Generate Access Token](https://docs.paveapi.com/integrations/developer-docs/authentication/generate-access-token.md): Implementation Examples of Access Token Generation in Various Programming Languages - [Sessions](https://docs.paveapi.com/integrations/developer-docs/sessions-1.md) - [POST Create Session](https://docs.paveapi.com/integrations/developer-docs/sessions-1/post-create-new-session.md): Create a new session for every User by generating a session\_key. - [GET Session Data](https://docs.paveapi.com/integrations/developer-docs/sessions-1/retrieve-a-session-data.md): During a session, retrieve details belonging to the API-Key by referencing the session\_key. - [GET Session Photos](https://docs.paveapi.com/integrations/developer-docs/sessions-1/get-a-session-photos.md): During a session, retrieve photos (as they get captured) belonging to the API-Key by referencing the session\_key. - [GET Session Notes](https://docs.paveapi.com/integrations/developer-docs/sessions-1/get-session-notes.md): During a session, retrieve notes belonging to the API-Key by referencing the session\_key. - [GET Session Results](https://docs.paveapi.com/integrations/developer-docs/sessions-1/get-a-session-results.md): Retrieve the completed vehicle details, inspection and photo results belonging to the API-Key by referencing the session\_key. - [PUT Update Session](https://docs.paveapi.com/integrations/developer-docs/sessions-1/update-a-session-data.md): Update the details you provided when creating a session belonging to the API-Key by referencing the session\_key - if it has not yet been started by the User. - [DELETE Session](https://docs.paveapi.com/integrations/developer-docs/sessions-1/delete-a-session.md): Delete a session belonging to the API-Key by referencing the session\_key - if it has not yet been stated by the User. - [Webhooks](https://docs.paveapi.com/integrations/developer-docs/callbacks.md): Creating a New Callback - [GET All Callbacks](https://docs.paveapi.com/integrations/developer-docs/callbacks/view-all-callbacks.md): See all callbacks created for your API-Key - [GET View a Callback](https://docs.paveapi.com/integrations/developer-docs/callbacks/get-view-a-callback.md): See a callback setting created for your API-Key - [POST Create New Callback](https://docs.paveapi.com/integrations/developer-docs/callbacks/set-a-new-callback.md): Set up a new callback for your API-Key. - [PUT Update a Callback](https://docs.paveapi.com/integrations/developer-docs/callbacks/update-an-existing-callback.md): Update a callback that was already set up for your API-Key. - [DELETE a Callback](https://docs.paveapi.com/integrations/developer-docs/callbacks/remove-an-existing-callback.md): Delete a callback that was already set up for your API-Key. - [Deep Linking](https://docs.paveapi.com/integrations/developer-docs/deep-linking.md): (Updated 5/1/2023) - [Deep Link with React Native App](https://docs.paveapi.com/integrations/developer-docs/deep-linking/deep-link-with-react-native-app.md) - [Deep Link Native App](https://docs.paveapi.com/integrations/developer-docs/deep-linking/deep-link-native-app.md): Follow the steps to set up deep-linking for your app. - [Deep Linking with Shareable Links](https://docs.paveapi.com/integrations/developer-docs/deep-linking/deep-linking-with-shareable-links.md) - [Pass-Through Additional User Information](https://docs.paveapi.com/integrations/developer-docs/pass-through-additional-user-information.md): How to Pass Additional User Information in PAVE API - [Tracking Your Sessions](https://docs.paveapi.com/integrations/developer-docs/tracking-your-sessions.md) - [User Session Lifecycle](https://docs.paveapi.com/integrations/developer-docs/user-session-lifecycle.md) - [Developer Testing](https://docs.paveapi.com/integrations/developer-docs/developer-testing.md) - [API details](https://docs.paveapi.com/integrations/developer-docs/api-details.md) - [POST Resend SMS](https://docs.paveapi.com/integrations/developer-docs/api-details/post-resend-sms.md): Send a reminder SMS with the original capture URL to the session’s recipient (Lithia use case). Allowed once per session within 7 days. - [Account Optional Add-ons](https://docs.paveapi.com/integrations/optional-customizations.md) - [Capture Only Theme (CAPT)](https://docs.paveapi.com/integrations/optional-customizations/capture-only-theme-capt.md): PAVE's Capture theme called CAPT enables a simple photo capture flow and a resulting CR for use cases that only require photo capture and not a full inspection. - [Skip Pictures](https://docs.paveapi.com/integrations/optional-customizations/capture-only-theme-capt/skip-pictures.md): Introducing the ability to skip a photo during inspection, if required (Available for PAVE CAPT theme only) - [Right-Hand-Drive Capture Flow](https://docs.paveapi.com/integrations/optional-customizations/right-hand-drive-capture-flow.md) - [Your Guide to PAVE's Account and Enterprise Dashboards](https://docs.paveapi.com/managing-your-account/your-guide-to-paves-account-and-enterprise-dashboards.md) - [PAVE Hotspots API](https://docs.paveapi.com/hotspots/pave-hotspots-api.md): Automate Damage Hotspots for 360˚-Vehicle Spins - [Activating PAVE Hotspots](https://docs.paveapi.com/hotspots/activating-pave-hotspots.md): Activate PAVE Hotspots directly from the Dashboard with ease - [Developer Docs](https://docs.paveapi.com/hotspots/developer-docs.md) - [Authentication](https://docs.paveapi.com/hotspots/developer-docs/authentication.md): The PAVE API requires authentication for all API calls, which is achieved through the use of an HMAC-SHA256 message hash as a header within the request. - [Generate Access Token](https://docs.paveapi.com/hotspots/developer-docs/authentication/generate-access-token.md): Implementation Examples of Access Token Generation in Various Programming Languages - [Sessions](https://docs.paveapi.com/hotspots/developer-docs/sessions.md) - [POST Create Session](https://docs.paveapi.com/hotspots/developer-docs/sessions/post-create-session.md): Create a new session for every User by generating a session\_key. - [POST Upload Photos](https://docs.paveapi.com/hotspots/developer-docs/sessions/post-upload-photos.md): Upload Vehicle Photos to the Hotspots API - [GET Results](https://docs.paveapi.com/hotspots/developer-docs/sessions/get-results.md): Retrieve the completed session results which include the damage details, damage co-ordinates, and the damage photos - [PAVE Capture Troubleshooting Guide](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide.md) - [iPhone (iOS) Issues](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/iphone-ios-issues.md) - [Does my mobile phone work with PAVE?](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/iphone-ios-issues/does-my-mobile-phone-work-with-pave.md) - [Can't Access Camera - Incorrect Web Browser Usage](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/iphone-ios-issues/cant-access-camera-incorrect-web-browser-usage.md) - [Can't Access Camera - Camera Permission Not Enabled](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/iphone-ios-issues/cant-access-camera-camera-permission-not-enabled.md) - [Camera Screen is Locked and won't Rotate](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/iphone-ios-issues/camera-screen-is-locked-and-wont-rotate.md) - [Inspection Get's Stuck](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/iphone-ios-issues/inspection-gets-stuck.md) - [Inspection Won't Begin or Complete](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/iphone-ios-issues/inspection-wont-begin-or-complete.md) - [Getting Back to an In-Progress Inspection](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/iphone-ios-issues/getting-back-to-an-in-progress-inspection.md) - [Why do I keep getting asked to retake pictures?](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/iphone-ios-issues/why-do-i-keep-getting-asked-to-retake-pictures.md) - [Android Phone Issues](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/android-phone-issues.md) - [Does my mobile phone work with PAVE?](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/android-phone-issues/does-my-mobile-phone-work-with-pave.md) - [Can't Access Camera - Incorrect Web Browser Usage](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/android-phone-issues/cant-access-camera-incorrect-web-browser-usage.md) - [Can't Access Camera - Camera Permission Not Enabled](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/android-phone-issues/cant-access-camera-camera-permission-not-enabled.md) - [Camera Screen is Locked and won't Rotate](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/android-phone-issues/camera-screen-is-locked-and-wont-rotate.md) - [Inspection Gets Stuck](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/android-phone-issues/inspection-gets-stuck.md) - [Inspection Won't Begin or Complete](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/android-phone-issues/inspection-wont-begin-or-complete.md) - [Getting Back to an In-Progress Inspection](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/android-phone-issues/getting-back-to-an-in-progress-inspection.md) - [Why do I keep getting asked to retake pictures?](https://docs.paveapi.com/other-resources/pave-capture-troubleshooting-guide/android-phone-issues/why-do-i-keep-getting-asked-to-retake-pictures.md) - [Policies](https://docs.paveapi.com/other-resources/policies.md) - [Service Level Agreement and Standards](https://docs.paveapi.com/other-resources/policies/service-slas.md) - [Service Delivery Sub-Processors & Processors](https://docs.paveapi.com/other-resources/policies/service-delivery-sub-processors-and-processors.md) - [API Strategy and Architecture](https://docs.paveapi.com/other-resources/policies/api-strategy-and-architecture.md) - [Information Security Policy](https://docs.paveapi.com/other-resources/policies/information-security-policy.md) - [Data Quality Guideline](https://docs.paveapi.com/other-resources/policies/information-security-policy/data-quality-guideline.md) - [Data Retention Policy](https://docs.paveapi.com/other-resources/policies/information-security-policy/data-retention-policy.md) - [Backup and Disaster Recovery](https://docs.paveapi.com/other-resources/policies/information-security-policy/backup-and-disaster-recovery.md) - [Data Residency](https://docs.paveapi.com/other-resources/policies/information-security-policy/data-residency.md) - [Data Access Control](https://docs.paveapi.com/other-resources/policies/information-security-policy/data-access-control.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.paveapi.com/master.md?ask= ``` 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.