Mobile SDK

iOS or Android

    API Reference - pims.authentication.trustedphonenumber

    Edit
    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:
    GET
    pims.authentication.trustedphonenumber
    Edit

    Returns the phone number if the user has one.

    Adding a phone number to the account could be performed using pims.authentication.smscode - addPhoneNumber or pims.authentication.smscode - modifyPhoneNumber.

    Input Parameter
    No params
    Output Data
    Data name Description Type Unit/Values Example
    phoneNumber

    Phone number.

    n/a

         		0612345678
    Error
    Error Code Error Label
    2001

    Facade not initialized
    2006

    Core not well configured
    2201

    Timeout/Polling Timeout/Command Timeout
    2202

    Network problem : No internet
    2204

    Server Error
    2307

    User dont have a phone number
    Code Example 
    1
2
3
4
5
6
7

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

    1
2
3
4
5
6
7

    pims.get(api: "pims.authentication.trustedphonenumber"
  /* no params */
  ) { (message) in 
    if message["status"] == "SUCEEDED"    { }    // 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": { 
  "phoneNumber": "0612345678"
} 
}

    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

    // 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: 2006 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2006,
    "label": "Core not well configured"
  }
}
/* -------- STATUS FAILED: 2201 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2201,
    "label": "Timeout/Polling Timeout/Command Timeout"
  }
}
/* -------- STATUS FAILED: 2202 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2202,
    "label": "Network problem : No internet"
  }
}
/* -------- STATUS FAILED: 2204 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2204,
    "label": "Server Error"
  }
}
/* -------- STATUS FAILED: 2307 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2307,
    "label": "User dont have a phone number"
  }
}