Mobile SDK

iOS or Android

    API Reference - pims.authentication.enrollment-enroll

    Info: Stellantis Mobile SDK for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is not publicly available for now.
    Available since: v2.0.X
    Component: StrongAuthentication
    Security: Authentication is required.
    Operation:

    This api allows to finalize device enrollment.

    You should use this API after receiving an smsCode from pims.authentication.enrollment - enroll.

    Input Parameter
    Param name Description Type Unit/Values Example Required
    action

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

    String

    enroll: finalize device enrollment

    enroll true
    pinCode

    Account PIN code value.

    Integer

    n/a

    1234 true
    smsCode

    SMS code value. See GET pims.authentication.smscode - enrollment. Only for iOS.

    Integer

    n/a

    true
    Output Data
    No data
    Error
    Error Code Error Label
    2001

    Facade not initialized

    2101

    Missing [PARAMETER] parameter

    2102

    Invalid [PARAMETER] parameter

    2305

    The sms code is invalid

    2308

    inwebo: access refused

    2309

    inwebo: version error

    2310

    inwebo: account is blocked

    2311

    inwebo: internal state not correct

    2312

    inwebo: device is disabled or unknown

    2313

    inwebo: User must activate inWebo helium or inWebo Desktop Token before achieving this operation

    2314

    inwebo: No service is available

    2316

    inwebo: the operation succeeded but it required a post-synchronization which failed

    2317

    inwebo: forbidden operation (due to activated state/blocked state/upgradable state)

    2344

    [Component] not configured

    Code Example
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    
    pims.set("pims.authentication.enrollment",
      mapOf( /* parameters */  
        Pair("action", "enroll"),
        Pair("pinCode", "1234"),
        Pair("smsCode", " ")
      ) 
    ) { 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
    
    pims.set(api: "pims.authentication.enrollment",
      parameters: [  
      "action": "enroll",
      "pinCode": "1234",
      "smsCode": " "
      ]
      ) { (message) in 
        if message["status"] == "SUCEEDED"    { }    // 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": null
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    
    // representation of the `failed` dictionary objects messages as JSON
    
    /* -------- STATUS FAILED: 2001 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2001,
        "label": "Facade not initialized"
      }
    }
    /* -------- STATUS FAILED: 2101 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2101,
        "label": "Missing [PARAMETER] parameter"
      }
    }
    /* -------- STATUS FAILED: 2102 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2102,
        "label": "Invalid [PARAMETER] parameter"
      }
    }
    /* -------- STATUS FAILED: 2305 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2305,
        "label": "The sms code is invalid"
      }
    }
    /* -------- STATUS FAILED: 2308 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2308,
        "label": "inwebo: access refused"
      }
    }
    /* -------- STATUS FAILED: 2309 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2309,
        "label": "inwebo: version error"
      }
    }
    /* -------- STATUS FAILED: 2310 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2310,
        "label": "inwebo: account is blocked "
      }
    }
    /* -------- STATUS FAILED: 2311 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2311,
        "label": "inwebo: internal state not correct"
      }
    }
    /* -------- STATUS FAILED: 2312 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2312,
        "label": "inwebo: device is disabled or unknown"
      }
    }
    /* -------- STATUS FAILED: 2313 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2313,
        "label": "inwebo: User must activate inWebo helium or inWebo Desktop Token before achieving this operation"
      }
    }
    /* -------- STATUS FAILED: 2314 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2314,
        "label": "inwebo: No service is available"
      }
    }
    /* -------- STATUS FAILED: 2316 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2316,
        "label": "inwebo: the operation succeeded but it required a post-synchronization which failed"
      }
    }
    /* -------- STATUS FAILED: 2317 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2317,
        "label": "inwebo: forbidden operation (due to activated state/blocked state/upgradable state)"
      }
    }
    /* -------- STATUS FAILED: 2344 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2344,
        "label": "[Component] not configured"
      }
    }