POST Create Session
Create a new session for every User by generating a session_key.
Endpoint
Headers
Create New Session
To create a new session, post your related information to the PAVE endpoint to generate a session_key
. A session_key
is a unique identifier for each user that is used to create one-time-use links. The user can return to their link at any time to continue their session.
Providing a PAVE Capture Link to the user is a three-step process:
Use the POST Create Session endpoint to obtain a session_key.
Add the session_key to the PAVE Capture URL to create a unique link for the user.
Provide the user with the link.
Sample Request
The following are the attributes of the Vehicle Object:
The attributes of the Vehicle Object serve two purposes: they allow you to skip the step of capturing the VIN for your end-user and provide PAVE with information about the vehicle that will be used in the session results. These attributes are represented as key/value pairs in a JSON format, where each attribute is given a name and corresponding value
The following are the attributes of the SMS Object:
The SMS Object contains the information required to send notifications via SMS in a session. This information is stored as named key/value pairs in a straightforward JSON format, providing a convenient optional way for the end-user to receive their capture link. The following are the attributes of the SMS Object:
The following are the attributes of the Options Object:
The options
object contains optional attributes that can be passed to customize the PAVE experience for each user. The object has the following properties:
Example
Need to Pass-Through Additional User or Session Information?
The PAVE API allows you to pass additional information about specific users in the JSON results for a session. This is useful when you want to combine information from different sources in a single session, for example, from a lead form on a website to the results payload sent to your CRM.
Visit this section for more information:
Authentication
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.
Please read the Authentication section to learn more:
POST Create Session Response with Capture Link
This section describes the response format for the POST request to create a session for a vehicle inspection, which includes the capture link to provide to the end-user. The response is in JSON format and contains the following fields:
Response Fields
Example Response
Here is an example response for the POST request to create a vehicle inspection session with the capture link included:
Sample Response (201:Ok)
The "capture_url" field contains the capture link that should be provided to the end user for starting the vehicle inspection. The "session_key" field contains a unique key identifying the vehicle inspection session. The end-user will be redirected to the "redirect_url" after completing the vehicle inspection.
Sample Response (400:Bad Request)
Last updated