Mobile SDK

iOS or Android

API Reference - pims.vehicle.carkey

Edit
Info: Stellantis Mobile SDK is not publicly available.
Component: 🔑  CarKey PSA
Tutorial: check-out CarKey.
SDK Version: v2.3
API Available since: v2.0
API Last update: v2.0
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
Operations:
SET
pims.vehicle.carkey

Activate a carKey.

Input Parameters Object
No input params.
Output Data Object
Data name Description Type Unit/Values Example
hasCarKey

True if car key is set with success, false otherwise.

Boolean

n/a/false

 		true
vin

Vehicle Identification Number

String

n/a

 		VR1AB12C3D45678909
securityCode

Security code

String

n/a

 		c2hhemFtCg==
securityExpiration

Expiration date of the security code.

String

date time

 		2021-07-29T22:25:09.898Z
Error
No errors
Code Example 
1
2
3
4
5
6
7

pims.set("pims.vehicle.carkey"
  /* no params */
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }

1
2
3
4
5
6
7

pims.set(api: "pims.vehicle.carkey"
  /* no params */
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 

1
2
3
4
5
6
7
8
9
10
11

// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": {
    "hasCarKey": true,
    "vin": "VR1AB12C3D45678909",
    "securityCode": "c2hhemFtCg==",
    "securityExpiration": "2021-07-29T22:25:09.898Z"
  }
}

false

Back to Ref List 2.3

🔑 CarKey PSA  APIs: