Skip to main content

Select Vehicles

Description

Select a vehicle to connect in order to retrieve Vehicle Data.

  • To use this API, an access token must be issued first.
  • On a successful call, the webview URL is returned.
  • When the returned URL is accessed, a vehicle selection and vehicle data sharing consent screen is displayed to the vehicle owner.

Endpoint

POST https://api.pleos.ai/v1/vehicles/selections

Request

curl
curl -X POST "https://api.pleos.ai/v1/vehicles/selections" \
-H "Authorization: Bearer <your_access_token>" \
-H "Content-Type: application/json" \
-H "Brand: hyundai" \
-d '{
"state": "state",
"lang": "en"
}'

Header Params

ParameterTypeDescriptionRequired
AuthorizationstringAccess tokenRequired
Content-Typestringapplication/jsonOptional
BrandstringVehicle brand (hyundai/kia/genesis)Required

Body Params

ParameterTypeDescriptionRequired
statestringState token value requested by the applicationRequired
langstringLanguage for the vehicle selection screen shown in WebViewRequired

Response

Success

200
{
"data": {
"redirectUrl": "https://api.pleos.ai/v1/vehicles/select-vehicle?lang=en&sessionId=abcdefgh-4098-488f-a20b-77072257c1234&gwToken=Bearer%20gBearer%20gMhJJYUepuP93SHsHwEILHzHiuXQ5X7kfBIe6L3I1ic1Sble4OHX7"
},
"meta": {
"code": 200,
"message": "Success",
"success": "true",
"timestamp": "2025-09-01T11:00:00Z",
"requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
}
}
data fieldTypeDescription
redirectUrlstringReturns a URL to open the vehicle selection screen.

Failure

4002
{
"error": {
"code": "4002",
"message": "Invalid request parameters",
"details": [],
"timestamp": "2025-09-01T12:00:00Z",
"requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
}
}
[Error Code]

For detailed explanations on error codes upon failure, refer to Error Code.