LogoLogo
  • PAVE OpenAPI Overview
  • How PAVE Works
    • Capture Link
    • Guided Capture
    • Customer Disclosures
    • Identified Vehicle Information
    • Captured Photos
    • Text Notifications
    • Inspection Results
    • Condition Report (PDF)
    • Detected Damages
    • Grading
    • Languages
    • Accuracy & Limitations
  • INTEGRATIONS
    • Developer Docs
      • Authentication
        • Generate Access Token
      • Sessions
        • POST Create Session
        • GET Session Data
        • GET Session Photos
        • GET Session Notes
        • GET Session Results
        • PUT Update Session
        • DELETE Session
      • Webhooks
        • GET All Callbacks
        • GET View a Callback
        • POST Create New Callback
        • PUT Update a Callback
        • DELETE a Callback
      • Deep Linking
        • Deep Link with React Native App
        • Deep Link Native App
        • Deep Linking with Shareable Links
      • Pass-Through Additional User Information
      • Tracking Your Sessions
      • User Session Lifecycle
      • Developer Testing
    • Account Optional Add-ons
      • Capture Only Theme (CAPT)
        • Skip Pictures
      • Right-Hand-Drive Capture Flow
  • MANAGING YOUR ACCOUNT
    • Your Guide to PAVE's Account and Enterprise Dashboards
  • Hotspots
    • PAVE Hotspots API
    • Activating PAVE Hotspots
    • Developer Docs
      • Authentication
        • Generate Access Token
      • Sessions
        • POST Create Session
        • POST Upload Photos
        • GET Results
  • OTHER RESOURCES
    • PAVE Capture Troubleshooting Guide
      • iPhone (iOS) Issues
        • Does my mobile phone work with PAVE?
        • Can't Access Camera - Incorrect Web Browser Usage
        • Can't Access Camera - Camera Permission Not Enabled
        • Camera Screen is Locked and won't Rotate
        • Inspection Get's Stuck
        • Inspection Won't Begin or Complete
        • Getting Back to an In-Progress Inspection
        • Why do I keep getting asked to retake pictures?
      • Android Phone Issues
        • Does my mobile phone work with PAVE?
        • Can't Access Camera - Incorrect Web Browser Usage
        • Can't Access Camera - Camera Permission Not Enabled
        • Camera Screen is Locked and won't Rotate
        • Inspection Gets Stuck
        • Inspection Won't Begin or Complete
        • Getting Back to an In-Progress Inspection
        • Why do I keep getting asked to retake pictures?
    • Policies
      • Service Level Agreement and Standards
      • Service Delivery Sub-Processors & Processors
      • API Strategy and Architecture
      • Information Security Policy
        • Data Quality Guideline
        • Data Retention Policy
        • Backup and Disaster Recovery
        • Data Residency
        • Data Access Control
Powered by GitBook
On this page
  1. INTEGRATIONS
  2. Developer Docs
  3. Deep Linking

Deep Linking with Shareable Links

PreviousDeep Link Native AppNextPass-Through Additional User Information

Last updated 9 months ago

A shareable link provides a convenient and code-free solution for generating new sessions within an account. Each shareable link widget has a static URL and is configured to launch a session with a configured API-Key and account. It also contains a redirect field that can be utilized for deep linking.

Details of the vehicle are decoded from a VIN that is retrieved during the photo capture process.

Shareable links are a widget type that is found/created under Settings > Widgets > Shareable Link within an account.

When creating a new shareable link, you need to enter a widget name and select the API key you wish to use for the inspections. The deep link back to your native application should be entered in the "Redirect URL"

Once created, the shareable link is accessed with the static URL in the widget dashboard and guides the user to create an inspection session by entering a phone number (first / last name optional).

Once the inspection is completed, the configured redirect within the shareable link widget will pass the user back to your native application.

Example: XXXXX

PAVE uses webhooks to pass the session key and sessions details such as inspection status and vehicle details back to your platform during a session and/or after it is completed. You can configure webhooks for all status changes and with custom data payloads. Learn more about PAVE webhooks here:

Once you receive a webhook notification for "STATUS: Complete", full details of the completed session can be retrieved from the PAVE API via "Get Session"

https://dashboard.paveapi.com/widget/1315137f-37b6-4a8d-90f6-da6042
https://docs.paveapi.com/integrations/developer-docs/callbacks
https://docs.paveapi.com/integrations/developer-docs/sessions-1/retrieve-a-session-data