From 50107e1b78571e67331e88936523b68ec2d141f9 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 5 Jul 2024 15:14:04 +0200 Subject: [PATCH 01/18] Add user stories Add user stories --- .../NumberVerification_verify_User_Story.md | 10 ++++++++++ ...NumberVerificationdevice_phone_number_User_Story.md | 10 ++++++++++ 2 files changed, 20 insertions(+) create mode 100644 documentation/API_documentation/NumberVerification_verify_User_Story.md create mode 100644 documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md diff --git a/documentation/API_documentation/NumberVerification_verify_User_Story.md b/documentation/API_documentation/NumberVerification_verify_User_Story.md new file mode 100644 index 0000000..82375a5 --- /dev/null +++ b/documentation/API_documentation/NumberVerification_verify_User_Story.md @@ -0,0 +1,10 @@ +# Number Verification Verify API User Story + +| **Item** | **Details** | +| ---- | ------- | +| ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the line from which the call was made, so that I can ensure that I avoid identity theft fraud. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
**Actors:** Application service providers, hyperscalers, application developers, end users.
**Scope:**
- Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | +| ***Pre-conditions*** |The preconditions are listed below:
  1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
  2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
  3. The Customer:Administrator has onboarded the Customer:User to the platform.
  4. The Customer:user performs an authorization request to CSP
  5. The means to get the access token are known to the Customer:User to ensure secure access of the API.| +| ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number keyed by the user on the application. This input could be hashed or plain.
    **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the line from which the request was triggered. | +| ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | +| ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
    - Unauthorized: Not valid credentials (e.g. use of already expired access token).
    - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
    - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections | \ No newline at end of file diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md new file mode 100644 index 0000000..dc80f94 --- /dev/null +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -0,0 +1,10 @@ +# Number Verification Device Phone Number API User Story + +| **Item** | **Details** | +| ---- | ------- | +| ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the line from which the call was made, so that I can ensure that I obtain the correct phone number and avoid identity theft fraud. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
    **Actors:** Application service providers, hyperscalers, application developers, end users.
    **Scope:**
    -Returns the phone number associated with the access token so API clients can get the number and verify it themselves. | +| ***Pre-conditions*** |The preconditions are listed below:
    1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
    2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
    3. The Customer:Administrator has onboarded the Customer:User to the platform.
    4. The Customer:user performs an authorization request to CSP
    5. The means to get the access token are known to the Customer:User to ensure secure access of the API.| +| ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
      **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the line from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| +| ***Post-conditions*** | TThe customer application could continue offering its service to the user with the confirmation of the user phone number. | +| ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
      - Unauthorized: Not valid credentials (e.g. use of already expired access token).
      - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
      - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections| \ No newline at end of file From 1ac7c9e074ee53be35e07967c050bf91016a1367 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 8 Jul 2024 15:37:29 +0200 Subject: [PATCH 02/18] Update documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md Co-authored-by: Axel Nennker --- .../NumberVerificationdevice_phone_number_User_Story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md index dc80f94..68dab00 100644 --- a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -6,5 +6,5 @@ | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
      **Actors:** Application service providers, hyperscalers, application developers, end users.
      **Scope:**
      -Returns the phone number associated with the access token so API clients can get the number and verify it themselves. | | ***Pre-conditions*** |The preconditions are listed below:
      1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
      2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
      3. The Customer:Administrator has onboarded the Customer:User to the platform.
      4. The Customer:user performs an authorization request to CSP
      5. The means to get the access token are known to the Customer:User to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
        **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the line from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| -| ***Post-conditions*** | TThe customer application could continue offering its service to the user with the confirmation of the user phone number. | +| ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | | ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
        - Unauthorized: Not valid credentials (e.g. use of already expired access token).
        - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
        - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections| \ No newline at end of file From 0f18860064ffbd8909a42581d6c85f8f17b053f3 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Jul 2024 15:45:57 +0200 Subject: [PATCH 03/18] Update NumberVerification_verify_User_Story following Jorge comments Update NumberVerification_verify_User_Story following Jorge comments --- .../NumberVerification_verify_User_Story.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/API_documentation/NumberVerification_verify_User_Story.md b/documentation/API_documentation/NumberVerification_verify_User_Story.md index 82375a5..4ea2010 100644 --- a/documentation/API_documentation/NumberVerification_verify_User_Story.md +++ b/documentation/API_documentation/NumberVerification_verify_User_Story.md @@ -2,9 +2,9 @@ | **Item** | **Details** | | ---- | ------- | -| ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the line from which the call was made, so that I can ensure that I avoid identity theft fraud. | +| ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the line from which the call was made, so I can get a proof of possession of the phone number. | | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
        **Actors:** Application service providers, hyperscalers, application developers, end users.
        **Scope:**
        - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | -| ***Pre-conditions*** |The preconditions are listed below:
        1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
        2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
        3. The Customer:Administrator has onboarded the Customer:User to the platform.
        4. The Customer:user performs an authorization request to CSP
        5. The means to get the access token are known to the Customer:User to ensure secure access of the API.| -| ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number keyed by the user on the application. This input could be hashed or plain.
          **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the line from which the request was triggered. | +| ***Pre-conditions*** |The preconditions are listed below:
          1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
          2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
          3. The Customer:Administrator has onboarded the Customer:User to the platform.
          4. The Customer:user performs an authorization request to CSP.
          5. The CSP checked access & user approval then provide accest token to the Customer:user
          6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| +| ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
            **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the line from which the request was triggered. | | ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | -| ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
            - Unauthorized: Not valid credentials (e.g. use of already expired access token).
            - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
            - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections | \ No newline at end of file +| ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
            - Unauthorized: Not valid credentials (e.g. use of already expired access token).
            - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
            - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections | From 43c44462a4720ca5683d5d2f937e9df407e3369a Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Jul 2024 15:47:37 +0200 Subject: [PATCH 04/18] Update NumberVerificationdevice_phone_number_User_Story following Jorge comment --- .../NumberVerificationdevice_phone_number_User_Story.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md index 68dab00..76023e0 100644 --- a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -4,7 +4,7 @@ | ---- | ------- | | ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the line from which the call was made, so that I can ensure that I obtain the correct phone number and avoid identity theft fraud. | | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
            **Actors:** Application service providers, hyperscalers, application developers, end users.
            **Scope:**
            -Returns the phone number associated with the access token so API clients can get the number and verify it themselves. | -| ***Pre-conditions*** |The preconditions are listed below:
            1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
            2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
            3. The Customer:Administrator has onboarded the Customer:User to the platform.
            4. The Customer:user performs an authorization request to CSP
            5. The means to get the access token are known to the Customer:User to ensure secure access of the API.| +| ***Pre-conditions*** |The preconditions are listed below:
              1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
              2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
              3. The Customer:Administrator has onboarded the Customer:User to the platform.
              4. The Customer:user performs an authorization request to CSP
              5. The CSP checked access & user approval then provide access token to the Customer:user
              6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
                **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the line from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| -| ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | -| ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
                - Unauthorized: Not valid credentials (e.g. use of already expired access token).
                - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
                - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections| \ No newline at end of file +| ***Post-conditions*** | TThe customer application could continue offering its service to the user with the confirmation of the user phone number. | +| ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
                - Unauthorized: Not valid credentials (e.g. use of already expired access token).
                - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
                - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections| From 037cecd0ae12a356f6a78904cf9482ccd7a713fe Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Jul 2024 15:48:10 +0200 Subject: [PATCH 05/18] Fix small typo --- .../API_documentation/NumberVerification_verify_User_Story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerification_verify_User_Story.md b/documentation/API_documentation/NumberVerification_verify_User_Story.md index 4ea2010..2ac46f6 100644 --- a/documentation/API_documentation/NumberVerification_verify_User_Story.md +++ b/documentation/API_documentation/NumberVerification_verify_User_Story.md @@ -4,7 +4,7 @@ | ---- | ------- | | ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the line from which the call was made, so I can get a proof of possession of the phone number. | | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                **Actors:** Application service providers, hyperscalers, application developers, end users.
                **Scope:**
                - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | -| ***Pre-conditions*** |The preconditions are listed below:
                1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                3. The Customer:Administrator has onboarded the Customer:User to the platform.
                4. The Customer:user performs an authorization request to CSP.
                5. The CSP checked access & user approval then provide accest token to the Customer:user
                6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| +| ***Pre-conditions*** |The preconditions are listed below:
                  1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                  2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                  3. The Customer:Administrator has onboarded the Customer:User to the platform.
                  4. The Customer:user performs an authorization request to CSP.
                  5. The CSP checked access & user approval then provide access token to the Customer:user
                  6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
                    **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the line from which the request was triggered. | | ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | | ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
                    - Unauthorized: Not valid credentials (e.g. use of already expired access token).
                    - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
                    - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections | From 260e4b93614d760deca50f56a5a3324a57b5c75c Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:42:40 +0200 Subject: [PATCH 06/18] Update documentation/API_documentation/NumberVerification_verify_User_Story.md Co-authored-by: Axel Nennker --- .../API_documentation/NumberVerification_verify_User_Story.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerification_verify_User_Story.md b/documentation/API_documentation/NumberVerification_verify_User_Story.md index 2ac46f6..3faed10 100644 --- a/documentation/API_documentation/NumberVerification_verify_User_Story.md +++ b/documentation/API_documentation/NumberVerification_verify_User_Story.md @@ -2,7 +2,8 @@ | **Item** | **Details** | | ---- | ------- | -| ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the line from which the call was made, so I can get a proof of possession of the phone number. | +| ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the phone from which the call was made, so I can get a proof of possession of the phone number. | + | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                    **Actors:** Application service providers, hyperscalers, application developers, end users.
                    **Scope:**
                    - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | | ***Pre-conditions*** |The preconditions are listed below:
                    1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                    2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                    3. The Customer:Administrator has onboarded the Customer:User to the platform.
                    4. The Customer:user performs an authorization request to CSP.
                    5. The CSP checked access & user approval then provide access token to the Customer:user
                    6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
                      **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the line from which the request was triggered. | From f8ff928a1f76df42e5c9ec47a6f83cdf63e02fbd Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:42:52 +0200 Subject: [PATCH 07/18] Update documentation/API_documentation/NumberVerification_verify_User_Story.md Co-authored-by: Axel Nennker --- .../API_documentation/NumberVerification_verify_User_Story.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerification_verify_User_Story.md b/documentation/API_documentation/NumberVerification_verify_User_Story.md index 3faed10..6e72597 100644 --- a/documentation/API_documentation/NumberVerification_verify_User_Story.md +++ b/documentation/API_documentation/NumberVerification_verify_User_Story.md @@ -5,7 +5,8 @@ | ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the phone from which the call was made, so I can get a proof of possession of the phone number. | | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                      **Actors:** Application service providers, hyperscalers, application developers, end users.
                      **Scope:**
                      - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | -| ***Pre-conditions*** |The preconditions are listed below:
                      1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                      2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                      3. The Customer:Administrator has onboarded the Customer:User to the platform.
                      4. The Customer:user performs an authorization request to CSP.
                      5. The CSP checked access & user approval then provide access token to the Customer:user
                      6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| +| ***Pre-conditions*** |The preconditions are listed below:
                        1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                        2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                        3. The Customer:Administrator has onboarded the Customer:User to the platform.
                        4. The Customer:User performs an authorization request to CSP.
                        5. The CSP checks access & user approval then provide access token to the Customer:User
                        6. The Customer:User get the access token based on network authentication to ensure secure access of the API.| + | ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
                          **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the line from which the request was triggered. | | ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | | ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
                          - Unauthorized: Not valid credentials (e.g. use of already expired access token).
                          - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
                          - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections | From 66eeae472d537f2c14ef2d5426742ddaade7ada4 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:42:59 +0200 Subject: [PATCH 08/18] Update documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md Co-authored-by: Axel Nennker --- .../NumberVerificationdevice_phone_number_User_Story.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md index 76023e0..27d6325 100644 --- a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -6,5 +6,6 @@ | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                          **Actors:** Application service providers, hyperscalers, application developers, end users.
                          **Scope:**
                          -Returns the phone number associated with the access token so API clients can get the number and verify it themselves. | | ***Pre-conditions*** |The preconditions are listed below:
                          1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                          2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                          3. The Customer:Administrator has onboarded the Customer:User to the platform.
                          4. The Customer:user performs an authorization request to CSP
                          5. The CSP checked access & user approval then provide access token to the Customer:user
                          6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
                            **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the line from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| -| ***Post-conditions*** | TThe customer application could continue offering its service to the user with the confirmation of the user phone number. | +| ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | + | ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
                            - Unauthorized: Not valid credentials (e.g. use of already expired access token).
                            - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
                            - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections| From d6f792149efa76a738e9f90eaf60679b263e642f Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:43:08 +0200 Subject: [PATCH 09/18] Update documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md Co-authored-by: Axel Nennker --- .../NumberVerificationdevice_phone_number_User_Story.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md index 27d6325..501c22e 100644 --- a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -2,7 +2,8 @@ | **Item** | **Details** | | ---- | ------- | -| ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the line from which the call was made, so that I can ensure that I obtain the correct phone number and avoid identity theft fraud. | +| ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the line from which the call was made, so that I can ensure that I obtain the correct phone number and avoid fraud e.g. identity theft. | + | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                            **Actors:** Application service providers, hyperscalers, application developers, end users.
                            **Scope:**
                            -Returns the phone number associated with the access token so API clients can get the number and verify it themselves. | | ***Pre-conditions*** |The preconditions are listed below:
                            1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                            2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                            3. The Customer:Administrator has onboarded the Customer:User to the platform.
                            4. The Customer:user performs an authorization request to CSP
                            5. The CSP checked access & user approval then provide access token to the Customer:user
                            6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
                              **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the line from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| From d2eae61cf5d413a3e932de99e7b9c4fd151ed3cd Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:43:18 +0200 Subject: [PATCH 10/18] Update documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md Co-authored-by: Axel Nennker --- .../NumberVerificationdevice_phone_number_User_Story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md index 501c22e..c1929ea 100644 --- a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -4,7 +4,7 @@ | ---- | ------- | | ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the line from which the call was made, so that I can ensure that I obtain the correct phone number and avoid fraud e.g. identity theft. | -| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                              **Actors:** Application service providers, hyperscalers, application developers, end users.
                              **Scope:**
                              -Returns the phone number associated with the access token so API clients can get the number and verify it themselves. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                              **Actors:** Application service providers, hyperscalers, application developers, end users.
                              **Scope:**
                              -Returns the phone number associated with the access token so API clients can get the phone number and verify it themselves. | | ***Pre-conditions*** |The preconditions are listed below:
                              1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                              2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                              3. The Customer:Administrator has onboarded the Customer:User to the platform.
                              4. The Customer:user performs an authorization request to CSP
                              5. The CSP checked access & user approval then provide access token to the Customer:user
                              6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
                                **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the line from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| | ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | From 916710e4b567932d1c6c7c1a295510f4e0a8fa45 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:43:25 +0200 Subject: [PATCH 11/18] Update documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md Co-authored-by: Axel Nennker --- .../NumberVerificationdevice_phone_number_User_Story.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md index c1929ea..1765667 100644 --- a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -5,7 +5,8 @@ | ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the line from which the call was made, so that I can ensure that I obtain the correct phone number and avoid fraud e.g. identity theft. | | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                **Actors:** Application service providers, hyperscalers, application developers, end users.
                                **Scope:**
                                -Returns the phone number associated with the access token so API clients can get the phone number and verify it themselves. | -| ***Pre-conditions*** |The preconditions are listed below:
                                1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                                2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                                3. The Customer:Administrator has onboarded the Customer:User to the platform.
                                4. The Customer:user performs an authorization request to CSP
                                5. The CSP checked access & user approval then provide access token to the Customer:user
                                6. The Customer:user get the access token based on network authentication to ensure secure access of the API.| +| ***Pre-conditions*** |The preconditions are listed below:
                                  1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                                  2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                                  3. The Customer:Administrator has onboarded the Customer:User to the platform.
                                  4. The Customer:user performs an authorization request to CSP
                                  5. The CSP checked access & user approval then provide access token to the Customer:user
                                  6. The Customer:User gets the access token based on network authentication to ensure secure access of the API.| + | ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
                                    **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the line from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| | ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | From a6ecc12d140f7dc66c05a7cf72bbbdf730392791 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:50:14 +0200 Subject: [PATCH 12/18] Add Communication service Provider in Actors --- .../API_documentation/NumberVerification_verify_User_Story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerification_verify_User_Story.md b/documentation/API_documentation/NumberVerification_verify_User_Story.md index 6e72597..ab87bbe 100644 --- a/documentation/API_documentation/NumberVerification_verify_User_Story.md +++ b/documentation/API_documentation/NumberVerification_verify_User_Story.md @@ -4,7 +4,7 @@ | ---- | ------- | | ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the phone from which the call was made, so I can get a proof of possession of the phone number. | -| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                    **Actors:** Application service providers, hyperscalers, application developers, end users.
                                    **Scope:**
                                    - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                    **Actors:** Application service providers, hyperscalers, application developers, end users, Communication Service Provider (CSP.
                                    **Scope:**
                                    - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | | ***Pre-conditions*** |The preconditions are listed below:
                                    1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                                    2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                                    3. The Customer:Administrator has onboarded the Customer:User to the platform.
                                    4. The Customer:User performs an authorization request to CSP.
                                    5. The CSP checks access & user approval then provide access token to the Customer:User
                                    6. The Customer:User get the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
                                      **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the line from which the request was triggered. | From 0ddfc052543f494ab4a3abe19846ba5ae5368bd6 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:50:46 +0200 Subject: [PATCH 13/18] Communication service Provider in Actors --- .../NumberVerificationdevice_phone_number_User_Story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md index 1765667..0bb0aeb 100644 --- a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -4,7 +4,7 @@ | ---- | ------- | | ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the line from which the call was made, so that I can ensure that I obtain the correct phone number and avoid fraud e.g. identity theft. | -| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                      **Actors:** Application service providers, hyperscalers, application developers, end users.
                                      **Scope:**
                                      -Returns the phone number associated with the access token so API clients can get the phone number and verify it themselves. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                      **Actors:** Application service providers, hyperscalers, application developers, end users, Communication Service Provider (CSP.
                                      **Scope:**
                                      -Returns the phone number associated with the access token so API clients can get the phone number and verify it themselves. | | ***Pre-conditions*** |The preconditions are listed below:
                                      1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                                      2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                                      3. The Customer:Administrator has onboarded the Customer:User to the platform.
                                      4. The Customer:user performs an authorization request to CSP
                                      5. The CSP checked access & user approval then provide access token to the Customer:user
                                      6. The Customer:User gets the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
                                        **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the line from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| From 105860f92bda9d2c640b3dfff345989d65ef23ab Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:52:32 +0200 Subject: [PATCH 14/18] changed line to device --- .../API_documentation/NumberVerification_verify_User_Story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerification_verify_User_Story.md b/documentation/API_documentation/NumberVerification_verify_User_Story.md index ab87bbe..e288b84 100644 --- a/documentation/API_documentation/NumberVerification_verify_User_Story.md +++ b/documentation/API_documentation/NumberVerification_verify_User_Story.md @@ -7,6 +7,6 @@ | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                        **Actors:** Application service providers, hyperscalers, application developers, end users, Communication Service Provider (CSP.
                                        **Scope:**
                                        - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | | ***Pre-conditions*** |The preconditions are listed below:
                                        1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                                        2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                                        3. The Customer:Administrator has onboarded the Customer:User to the platform.
                                        4. The Customer:User performs an authorization request to CSP.
                                        5. The CSP checks access & user approval then provide access token to the Customer:User
                                        6. The Customer:User get the access token based on network authentication to ensure secure access of the API.| -| ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
                                          **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the line from which the request was triggered. | +| ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
                                          **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the device from which the request was triggered. | | ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | | ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
                                          - Unauthorized: Not valid credentials (e.g. use of already expired access token).
                                          - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
                                          - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections | From 36db56a41be6b9d42c29eadcae65c984cdfa5ece Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 22 Jul 2024 13:53:16 +0200 Subject: [PATCH 15/18] Changed line to device --- .../NumberVerificationdevice_phone_number_User_Story.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md index 0bb0aeb..deebb8b 100644 --- a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -2,12 +2,12 @@ | **Item** | **Details** | | ---- | ------- | -| ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the line from which the call was made, so that I can ensure that I obtain the correct phone number and avoid fraud e.g. identity theft. | +| ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the device from which the call was made, so that I can ensure that I obtain the correct phone number and avoid fraud e.g. identity theft. | | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                          **Actors:** Application service providers, hyperscalers, application developers, end users, Communication Service Provider (CSP.
                                          **Scope:**
                                          -Returns the phone number associated with the access token so API clients can get the phone number and verify it themselves. | | ***Pre-conditions*** |The preconditions are listed below:
                                          1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                                          2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                                          3. The Customer:Administrator has onboarded the Customer:User to the platform.
                                          4. The Customer:user performs an authorization request to CSP
                                          5. The CSP checked access & user approval then provide access token to the Customer:user
                                          6. The Customer:User gets the access token based on network authentication to ensure secure access of the API.| -| ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
                                            **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the line from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| +| ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
                                            **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the device from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| | ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | | ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
                                            - Unauthorized: Not valid credentials (e.g. use of already expired access token).
                                            - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
                                            - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections| From a12d92e1b00e4722076df1e7ca1da3e9de4f9afd Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 24 Jul 2024 14:53:10 +0200 Subject: [PATCH 16/18] Update NumberVerification_verify_User_Story.md --- .../API_documentation/NumberVerification_verify_User_Story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerification_verify_User_Story.md b/documentation/API_documentation/NumberVerification_verify_User_Story.md index e288b84..7a122cb 100644 --- a/documentation/API_documentation/NumberVerification_verify_User_Story.md +++ b/documentation/API_documentation/NumberVerification_verify_User_Story.md @@ -4,7 +4,7 @@ | ---- | ------- | | ***Summary*** | As an enterprise application developer, I want to verify the phone number associated with the phone from which the call was made, so I can get a proof of possession of the phone number. | -| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                            **Actors:** Application service providers, hyperscalers, application developers, end users, Communication Service Provider (CSP.
                                            **Scope:**
                                            - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                            **Actors:** Application service providers, hyperscalers, application developers, end users, Communication Service Provider (CSP).
                                            **Scope:**
                                            - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | | ***Pre-conditions*** |The preconditions are listed below:
                                            1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                                            2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                                            3. The Customer:Administrator has onboarded the Customer:User to the platform.
                                            4. The Customer:User performs an authorization request to CSP.
                                            5. The CSP checks access & user approval then provide access token to the Customer:User
                                            6. The Customer:User get the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
                                              **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the device from which the request was triggered. | From ecade42d0c834535ae57ec01ec6a242f9e81c96f Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 24 Jul 2024 14:53:24 +0200 Subject: [PATCH 17/18] Update NumberVerificationdevice_phone_number_User_Story.md --- .../NumberVerificationdevice_phone_number_User_Story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md index deebb8b..b2d51c3 100644 --- a/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md +++ b/documentation/API_documentation/NumberVerificationdevice_phone_number_User_Story.md @@ -4,7 +4,7 @@ | ---- | ------- | | ***Summary*** | As an enterprise application developer, I want to retrieve the phone number associated with the device from which the call was made, so that I can ensure that I obtain the correct phone number and avoid fraud e.g. identity theft. | -| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                              **Actors:** Application service providers, hyperscalers, application developers, end users, Communication Service Provider (CSP.
                                              **Scope:**
                                              -Returns the phone number associated with the access token so API clients can get the phone number and verify it themselves. | +| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                              **Actors:** Application service providers, hyperscalers, application developers, end users, Communication Service Provider (CSP).
                                              **Scope:**
                                              -Returns the phone number associated with the access token so API clients can get the phone number and verify it themselves. | | ***Pre-conditions*** |The preconditions are listed below:
                                              1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                                              2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                                              3. The Customer:Administrator has onboarded the Customer:User to the platform.
                                              4. The Customer:user performs an authorization request to CSP
                                              5. The CSP checked access & user approval then provide access token to the Customer:user
                                              6. The Customer:User gets the access token based on network authentication to ensure secure access of the API.| | ***Activities/Steps*** | **Starts when:** The customer application makes a POST device phone number via the number verification API.
                                                **Ends when:** The Number verification server answers providing the phone number corresponding to the one of the device from which the request was triggered. The customer application can check if this number corresponds to the one keyed by the user.| From 4ddbc75e172bef7d149f058903fc2803254cca37 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 24 Jul 2024 16:17:30 +0200 Subject: [PATCH 18/18] Update NumberVerification_verify_User_Story.md --- .../API_documentation/NumberVerification_verify_User_Story.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerification_verify_User_Story.md b/documentation/API_documentation/NumberVerification_verify_User_Story.md index 7a122cb..c64a9b3 100644 --- a/documentation/API_documentation/NumberVerification_verify_User_Story.md +++ b/documentation/API_documentation/NumberVerification_verify_User_Story.md @@ -7,6 +7,6 @@ | ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator
                                                **Actors:** Application service providers, hyperscalers, application developers, end users, Communication Service Provider (CSP).
                                                **Scope:**
                                                - Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using. | | ***Pre-conditions*** |The preconditions are listed below:
                                                1. The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.
                                                2. The Customer:BusinessManager has successfully subscribed to the Number Verification product from the product catalog.
                                                3. The Customer:Administrator has onboarded the Customer:User to the platform.
                                                4. The Customer:User performs an authorization request to CSP.
                                                5. The CSP checks access & user approval then provide access token to the Customer:User
                                                6. The Customer:User get the access token based on network authentication to ensure secure access of the API.| -| ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
                                                  **Ends when:** The Number verification server answers if the phone number provided corresponds to the one of the device from which the request was triggered. | +| ***Activities/Steps*** | **Starts when:** The customer application makes a POST verify via the number verification API providing in the request the phone number provided by the user on the application. This input could be hashed or plain.
                                                  **Ends when:** The Number Verification Server responds to confirm whether the provided phone number matches the device from which the request was initiated or not. | | ***Post-conditions*** | The customer application could continue offering its service to the user with the confirmation of the user phone number. | | ***Exceptions*** | Several exceptions might occur during the Number Verification API operations
                                                  - Unauthorized: Not valid credentials (e.g. use of already expired access token).
                                                  - Invalid input: Not valid input data to invoke operation (e.g. phone number without the '+' prefix).
                                                  - Not able to provide: Client authentication was not performed via mobile network. Not working on mobile hotspot (tethering) neither Wifi nor VPN mobile connections |