Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update user story #132

Merged
merged 2 commits into from
Aug 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions documentation/API_documentation/SIM-Swap_check_User_Story.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
| **Item** | **Details** |
| ---- | ------- |
| ***Summary*** | As an enterprise application developer, I want to check if a SIM swap has occurred within a specified period for a user's mobile number so that I can enhance security measures against account takeover fraud. |
| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator<br> **Actors:** Application service providers, hyperscalers, application developers, end users, Communication service Provider (CSP). <br> **Scope:** <br> - Checks if a SIM Swap has occurred within a specified period for a given phone number. |
| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.</li><li>The Customer:BusinessManager has successfully subscribed to the SIM Swap API product from the product catalog.</li><li>The Customer:Administrator has onboarded the Customer:User to the platform.</li><li>The Customer:User performs an authorization request to CSP</li><li>The Customer:User has the access token allowing the access of the API and SIM Swap information of the target phoneNumber, if applies|
| ***Activities/Steps*** | **Starts when:** The customer application makes a POST request to the /check endpoint via the SIM Swap API, providing the phone number and the desired period to check for SIM swaps.<br>**Ends when:** The CSP's SIM Swap server responds indicating whether a SIM swap has been performed within the specified period. |
| ***Post-conditions*** | The customer application could continue offering its service to the end user with the confirmation of the validity of the SIM based on the SIM Swap information. |
| ***Exceptions*** | Several exceptions might occur during the SIM Swap API operations<br>- Unauthorized: Not valid credentials (e.g., use of already expired access token).<br>- Invalid input: Not valid input data to invoke operation (e.g., improperly formatted phone number).|
| ***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP). <br>**Scope:** <br> - Checks if a SIM swap has occurred within a specified period for a given phone number. |
| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The ASP:BusinessManager and ASP:Administrator have been onboarded to the CSP's API platform via (or not) a Channel Partner.</li><li>The ASP:BusinessManager has successfully subscribed to the SIM Swap API product from the CSP's product catalog via (or not) a Channel Partner.</li><li>The ASP:Administrator has onboarded the ASP:User to the platform.</li><li>The ASP:User performs an authorization request to CSP</li><li> The CSP checks access & End-User approval then provide access token to the ASP:User </li><li>The ASP:User get the access token, via (or not) the Channel Partner, allowing a secure access of the API.|
| ***Activities/Steps*** | **Starts when:** The ASP:User makes a POST request via the SIM Swap API, providing the phone number and the desired period to check for SIM swaps. This request could be done via (or not) the Channel Partner.<br>**Ends when:** The CSP's SIM Swap server responds indicating whether a SIM Swap has been performed within the specified period. |
| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the validity of the SIM based on the SIM Swap information. |
| ***Exceptions*** | Several exceptions might occur during the SIM Swap API operations<br>- Unauthorized: Not valid credentials (e.g., use of already expired access token).<br>- Invalid input: Not valid input data to invoke operation (e.g., improperly formatted phone number).|
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

| **Item** | **Details** |
| ---- | ------- |
| ***Summary*** | As an enterprise application developer, I want to verify the last SIM Swap date for a user's mobile number so that I can enhance security measures against account takeover fraud. |
| ***Roles, Actors and Scope*** | **Roles:** Customer:User, Customer:BusinessManager, Customer:Administrator<br> **Actors:** Application service providers, hyperscalers, application developers, end users, Communication service Provider (CSP). <br> **Scope:** <br> - Retrieves the timestamp of the last SIM Swap event for a given phone number. |
| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.</li><li>The Customer:BusinessManager has successfully subscribed to the SIM Swap API product from the product catalog.</li><li>The Customer:Administrator has onboarded the Customer:User to the platform.</li><li>The Customer:User performs an authorization request to CSP</li><li>The Customer:User has the access token allowing the access of the API and SIM Swap information of the target phoneNumber, if applies"|
| ***Activities/Steps*** | **Starts when:** The customer application makes a POST request to the /retrieve-date endpoint via the SIM Swap API, including the phone number provided by the user in the application.<br>**Ends when:** The CSP's SIM Swap server responds with the timestamp of the last SIM swap event, or the SIM activation date if no swap has occurred. |
| ***Post-conditions*** | The customer application could continue offering its service to the end user with the confirmation of the validity of the SIM based on the SIM Swap information. |
| ***Summary*** | As an enterprise application developer, I want to verify the last SIM swap date for a user's mobile number so that I can enhance security measures against account takeover fraud. |
|***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP). <br>**Scope:** <br> - Retrieves the timestamp of the last SIM swap event for a given phone number. |
| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The ASP:BusinessManager and ASP:Administrator have been onboarded to the CSP's API platform via (or not) a Channel Partner.</li><li>The ASP:BusinessManager has successfully subscribed to the SIM Swap API product from the CSP's product catalog via (or not) a Channel Partner.</li><li>The ASP:Administrator has onboarded the ASP:User to the platform.</li><li>The ASP:User performs an authorization request to CSP</li><li> The CSP checks access & End-User approval then provide access token to the ASP:User </li><li>The ASP:User get the access token, via (or not) the Channel Partner, allowing a secure access of the API.|
| ***Activities/Steps*** | **Starts when:** The ASP:User makes a POST request via the SIM Swap API, including the phone number provided by the End-User in the ASP:User.<br>**Ends when:** The CSP's SIM Swap server responds with the timestamp of the last SIM swap event, or the SIM activation date if no swap has occurred. |
| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the validity of the SIM based on the SIM Swap information. |
| ***Exceptions*** | Several exceptions might occur during the SIM Swap API operations<br>- Unauthorized: Not valid credentials (e.g., use of already expired access token).<br>- Invalid input: Not valid input data to invoke operation (e.g., improperly formatted phone number).<br>- Not able to provide: Legal restrictions or data retention policies preventing the retrieval of the requested information.|