Deep Linking with Shareable Links

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).

Example: https://dashboard.paveapi.com/widget/1315137f-37b6-4a8d-90f6-da6042XXXXX

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

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: https://docs.paveapi.com/integrations/developer-docs/callbacks

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://docs.paveapi.com/integrations/developer-docs/sessions-1/retrieve-a-session-data