API Reference - pims.authentication.account-isAccountBlocked
Info: Stellantis Mobile SDK is not publicly available.
Component:
📱
Enrollment
PSA
Tutorial:
check-out
Enrollment.
SDK Version:
v2.3
API Available since:
v2.0
API Last update:
v2.0
Plateforme Compatibility: PSA
Security:
- Authentication: Authentication is required.
Operations:
Returns if the account is blocked or not.
Input Parameters Object | |||||
---|---|---|---|---|---|
Param name | Description | Type | Unit/Values | Example | Required |
actionType | Action Name, in this case |
String |
|
strong
|
true |
type | Retrieve if account is blocked. |
String |
|
isAccountBlocked
|
true |
Output Data Object | ||||
---|---|---|---|---|
Data name | Description | Type | Unit/Values | Example |
isAccountBlocked | Indicates if the user account’s is blocked or not. |
Enum of Strings |
- Unknown
- PinBlocked
- NotBlocked
|
NotBlocked
|
Error | ||
---|---|---|
No errors |
Code Example
1
2
3
4
5
6
7
8
9
10
pims.get("pims.authentication.account",
mapOf( /* parameters */
Pair("actionType", "strong"),
Pair("type", "isAccountBlocked")
)
) { 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.account",
parameters: [
"actionType": "strong",
"type": "isAccountBlocked"
]
) { (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": {
"isAccountBlocked": "NotBlocked"
}
}
false