Mobile SDK

iOS or Android

API Reference - pims.authentication.otp-withPIN

Edit
Info: Stellantis Mobile SDK is not publicly available.
Component: 📱  Enrollment PSA
Tutorial: check-out Enrollment.
SDK Version: v2.2
API Available since: v2.0
API Last update: v2.0
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
Operations:
GET
pims.authentication.otp - withPIN

Returns an OTP (One Time Password) with PIN.

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

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

String

withPIN: get otp with pin

 		withPIN true
pinCode

Account PIN code value.

String

n/a

 		1234 true
Output Data
Data name Description Type Unit/Values Example
otp

OTP value.

String

n/a
Error
Code Type Message
2000 Generic error

Unknown error
2001 Generic error

Facade not initialized
2006 Generic error

Core not well configured
2101 Input error

Missing [PARAMETER] parameter
2102 Input error

Invalid [PARAMETER] parameter
2202 Output Error

Network problem : No internet
2308 PIMS specific error

inwebo: access refused
2309 PIMS specific error

inwebo: version error
2310 PIMS specific error

inwebo: account is blocked
2311 PIMS specific error

inwebo: internal state not correct
2312 PIMS specific error

inwebo: device is disabled or unknown
2313 PIMS specific error

inwebo: User must activate inWebo helium or inWebo Desktop Token before achieving this operation
2314 PIMS specific error

inwebo: No service is available
2316 PIMS specific error

inwebo: the operation succeeded but it required a post-synchronization which failed
2317 PIMS specific error

inwebo: forbidden operation (due to activated state/blocked state/upgradable state)
Code Example 
1
2
3
4
5
6
7
8
9
10

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

1
2
3
4
5
6
7
8
9
10

pims.get(api: "pims.authentication.otp",
  parameters: [  
  "action": "withPIN",
  "pinCode": "1234"
  ]
  ) { (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

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

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
129
130
131
132
133
134
135
136
137

// representation of the `failed` dictionary objects messages as JSON

/* -------- STATUS FAILED: 2000 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2000,
    "label": "Unknown error"
  }
}
/* -------- STATUS FAILED: 2001 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2001,
    "label": "Facade not initialized"
  }
}
/* -------- STATUS FAILED: 2006 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2006,
    "label": "Core not well configured"
  }
}
/* -------- 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: 2202 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2202,
    "label": "Network problem : No internet"
  }
}
/* -------- 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)"
  }
}

Back to Ref List 2.2

📱 Enrollment PSA APIs: