Mobile SDK

iOS or Android

API Reference - pims.authentication.enrollment-enrollWithPhoneNumber

Edit
Info: Stellantis Mobile SDK is not publicly available.
Component: 📱  Enrollment PSA
Tutorial: check-out Enrollment.
SDK Version: v2.3
API Available since: v2.1
API Last update: v2.1
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
Operations:
SET
pims.authentication.enrollment - enrollWithPhoneNumber

This api allows to finalize device enrollment and add phone number in the same time.

You should use this API after receiving an smsCode from pims.authentication.smscode - phoneNumberCertification.

Input Parameters Object
Param name Description Type Unit/Values Example Required
action

Name of the action to perform, in this case enrollWithPhoneNumber.

String

enrollWithPhoneNumber: finalize enrollment

 		enrollWithPhoneNumber true
pinCode

Account PIN code value.

String

n/a

 		1234 true
smsCode

SMS code value. See GET pims.authentication.smscode - phoneNumberCertification.

String

n/a

 		true
phoneNumber

phone number value.

String

n/a

 		true
Output Data Object
No outputted data
Error
No errors
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12

pims.set("pims.authentication.enrollment",
  mapOf( /* parameters */  
    Pair("action", "enrollWithPhoneNumber"),
    Pair("pinCode", "1234"),
    Pair("smsCode", " "),
    Pair("phoneNumber", " ")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }

1
2
3
4
5
6
7
8
9
10
11
12

pims.set(api: "pims.authentication.enrollment",
  parameters: [  
    "action": "enrollWithPhoneNumber",
    "pinCode": "1234",
    "smsCode": " ",
    "phoneNumber": " "
  ]
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 

1
2
3
4
5
6

// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": { }
}

false

Back to Ref List 2.3

📱 Enrollment PSA  APIs: