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

User Stories Documentation #10

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
24 changes: 24 additions & 0 deletions documentation/API_documentation/telco-index-User-Story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
**User Story: Credit scoring service for banking**
<br>

| **Item** | **Details** |
| -------- | ----------- |
| ***Summary*** | As a bank officer, I want to evaluate a micro-credit application for a customer who has no credit history within our bank. I use the Customer Insights API to gather additional information about the customer's telco behavior to assess their creditworthiness. |
| ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Bank Officer, Bank System, Communication Service Provider (CSP)<br> **Scope:** Retrieve a relevant score calculated from the data of the CSP, enabling the bank to make an informed decision on micro-credit approval. |
| ***Pre-conditions*** | The preconditions are listed below:<br><ol><li>The bank is integrated with the CSP's Customer Insights API.</li><li>The customer has consented to sharing their telco data for credit assessment purposes.</li><li>The bank officer has the necessary credentials to access the Customer Insights API.</li></ol> |
| ***Activities/Steps*** | **Begins when:** The bank officer submits a micro-credit application for a customer without an existing credit history.<br><br>**Steps include:**<br><ol><li>The bank system makes a request to the Customer Insights API using customer consented information.</li><li>The CSP processes the request and gathers telco-related behavioral insights.</li><li>The CSP sends a calculated score to the bank system.</li><li>The bank officer evaluates the score to assess the credit risk of the customer.</li></ol><br> **Ends when:** The bank officer either approves or declines the micro-credit application based on the insights provided. |
| ***Post-conditions*** | The bank officer has sufficient data to approve or deny the micro-credit request for a customer without a traditional credit history. |
| ***Exceptions*** | Several exceptions might occur during the Customer Insights API operations:<br>- Unauthorized: Invalid credentials provided by the bank system.<br>- Consent missing: The customer has not provided consent for sharing telco data (i.e. permission denied).<br>- Data not found: Insufficient user data available for the customer.<br>- Corporate customers: The API is not applicable for corporate customers. |


**User Story: Credit scoring service for riders**
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are multiple APIs and multiple service providers in this story - this may be confusing.

<br>

| **Item** | **Details** |
| -------- | ----------- |
| ***Summary*** | As a service provider, I want to evaluate the creditworthiness of riders working for food delivery, errands, and other similar applications. I use the Credit Insights API to generate a score for these riders, which can be used by companies and banks to offer credit services to the riders for purchasing a motorcycle, bicycle, or electric scooter. The application can leverage the Customer Insights API to complement the score generated with additional telco data, enhancing the overall credit score. |
Copy link

@rartych rartych Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I use the Credit Insights API to generate a score

Can we call Credit Insights API just external API without naming it?

| ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Service Provider, Bank System, Rider, Application Service Provider (ASP), Communication Service Provider (CSP)<br> **Scope:** Retrieve relevant behavioral data about the riders from both the delivery apps and the CSP, enabling a comprehensive credit score calculation to support credit decisions for vehicle purchases. |
| ***Pre-conditions*** | The preconditions are listed below:<br><ol><li>The service provider is integrated with both the delivery applications and the CSP's Customer Insights API.</li><li>The rider has consented to share their delivery and telco data for credit assessment purposes.</li><li>The service provider has the necessary credentials to access Customer Insights API and the path to route to the right CSP.</li></ol> |
| ***Activities/Steps*** | **Begins when:** The service provider initiates a credit assessment for a rider interested in purchasing a vehicle (motorcycle, bicycle, or electric scooter).<br><br>**Steps include:**<br><ol><li>The service provider collects rider activity data from the delivery applications, including job completion rates, earnings, and overall performance.</li><li>The service provider makes a request to External Platforms API(s) available in the market (solution outside CAMARA, but to illustrate a real use case) using the collected data and rider consent details.</li><li>The external CSP processes the request and generates a preliminary credit score based on the rider's delivery activities.</li><li>The service provider then makes a request to the Customer Insights API to retrieve additional telco-related score about the rider.</li><li>The CSP processes the request and gathers telco-related behavioral insights. The CSP sends a final enhanced credit score to the service provider.</li><li>The service provider evaluates the received scores to assess the rider's creditworthiness for purchasing a vehicle.</li></ol><br> **Ends when:** The service provider either approves or declines the credit application based on the insights provided. |
Copy link

@rartych rartych Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The external CSP processes the request and generates a preliminary credit score based on the rider's delivery activities.

I guess it is external ASP not CSP

| ***Post-conditions*** | The service provider has sufficient data to approve or deny the credit request for a rider based on a comprehensive score derived from both delivery app activity and telco data. |
| ***Exceptions*** | Several exceptions might occur during the Customer Insights API operations:<br>- Unauthorized: Invalid credentials provided by the service provider.<br>- Consent missing: The rider has not provided consent for sharing delivery or telco data (i.e. permission denied).<br>- Data not found: Insufficient data available from delivery apps or telco records for the rider.<br>- Corporate customers: The API is not applicable for corporate customers. |