Skip to main content

Vehicle Selection and Data Sharing Consent

[Preliminary Step]

To follow the procedures in this topic, you need to acquire the required parameters through authentication.

STEP 1. Retrieve Vehicle List

Retrieve the list of vehicles for which the vehicle owner has consented to share data.
Call Get Vehicles to retrieve the vehicle list.

curl
curl -X GET "https://api.pleos.ai/v1/vehicles/consent" \
-H "Authorization: Bearer <your_access_token>" \
-H "Content-Type: application/json" \
-H "Brand: hyundai" \
  • If no vehicles are returned, proceed to STEP 2.
  • If vehicles are returned, check the vehicle identification number and use it as a path parameter when calling the Vehicle Data API.

To obtain data sharing consent from the vehicle owner, a screen for vehicle selection and vehicle data sharing consent must be provided.
Call Select Vehicles to retrieve the Webview URL for the vehicle selection screen.

  • On a successful call, a Webview URL is returned.
  • Calling the returned URL displays the vehicle selection and data sharing consent screen to the vehicle owner.

From the screen shown in STEP 2, the vehicle owner selects which vehicle’s data to share and agrees or declines consent. Regardless of the consent decision, the process proceeds with the Consent Completion Redirect URL to complete STEP 2. Then return to STEP 1 to retrieve the vehicle identification number.

caution

Developers must implement a feature that allows vehicle owners to revoke previously granted data sharing consent. You can use Delete Consent to implement this feature.