generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #119 from fernandopradocabrillo/kyc-match-and-fill…
…-in-Fall24 Pre release r1.1 for kyc-match + kyc-fill-in + CHANGELOG + README
- Loading branch information
Showing
7 changed files
with
141 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 27 additions & 27 deletions
54
...entation/Know Your Customer User Story.md → ...umentation/KnowYourCustomer_User_Story.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,27 @@ | ||
| **User Story: KYC Match - verify customer information** | ||
| <br> | ||
|
|
||
| | **Item** | **Details** | | ||
| | ---- | ------- | | ||
| | ***Summary*** | As an application developer belonging to an enterprise, I want to confirm (using my application server/backend service) the identity of a customer by comparison to MNO user's information. Information which could be provided are phone number, given name, family name, street address, city, country, region, postal code, birthdate, email address, etc. | | ||
| | ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Mobile Network Operators (MNO), hyperscalers, application developers, enterprise. <br> **Scope:** Any phone line (not limlited to 4G, 5G) | | ||
| | ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer:User has provided mandatory information of its identity</li><li>Application developer has onboarded to MNO API</li><li>Application developer has API credentials</li><li>Privacy legal base requirement has been solved (Customer privacy) </li></ol>| | ||
| | ***Activities/Steps*** | **Starts when:** The customer application server makes a request to the KYC service (API) to confirm user identity.<br>**Ends when:** The MNO service returns matching result for each attribute of the customer identity.<br> | | ||
| | ***Post-conditions*** | The application developer can make decision to use this customer data to follow-up its process| | ||
| | ***Exceptions*** | Several exceptions might occur during the KYC Match API operations:<br><ul><li>Unauthorized: Not valid credentials (e.g. use of already expired access token).</li><li>Not Found: The number provided is not managed by the MNO</li><li>Invalid input: Not all mandatory input data to invoke operation (e.g. phone number).</li></ul>| | ||
|
|
||
| <br><br> | ||
|
|
||
| **User Story: KYC Fill-In - Get identity information of customer** | ||
| <br> | ||
|
|
||
| | **Item** | **Details** | | ||
| | ---- | ------- | | ||
| | ***Summary*** | As an application developer belonging to an enterprise, I want to retreive (using my application server/backend service) the identity information of a user by requesting the MNO to query information stored in its customer database. Information returned by the MNO are given name, family name, street address, city, country, region, postal code, birthdate, email address, etc. | | ||
| | ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Mobile Network Operators (MNO), hyperscalers, application developers, enterprise. <br> **Scope:** Any phone line (not limlited to 4G, 5G) | | ||
| | ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer:User has provided mandatory information of its identity</li><li>Application developer has onboarded to MNO API</li><li>Application developer has API credentials</li><li>Privacy legal base requirement has been solved (Customer privacy) </li></ol>| | ||
| | ***Activities/Steps*** | **Starts when:** The third party/enterprise customer application server makes a request to the KYC service (API) to retreive user identity information.<br>**Ends when:** The MNO service returns the identity information stored in its customer database.<br> | | ||
| | ***Post-conditions*** | The application developer uses this customer data to follow-up its process | | ||
| | ***Exceptions*** | Several exceptions might occur during the KYC Fill-in API operations:<br><ul><li>Unauthorized: Not valid credentials (e.g. use of already expired access token).</li><li>Not Found: The number provided is not managed by the MNO</li><li>Invalid input: Not all mandatory input data to invoke operation (e.g. phone number).</li></ul>| | ||
|
|
||
|
|
||
| **User Story: KYC Match - verify customer information** | ||
| <br> | ||
|
|
||
| | **Item** | **Details** | | ||
| | ---- | ------- | | ||
| | ***Summary*** | As an application developer belonging to an enterprise, I want to confirm (using my application server/backend service) the identity of a customer by comparison to MNO user's information. Information which could be provided are phone number, given name, family name, street address, city, country, region, postal code, birthdate, email address, etc. | | ||
| | ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Mobile Network Operators (MNO), hyperscalers, application developers, enterprise. <br> **Scope:** Any phone line (not limlited to 4G, 5G) | | ||
| | ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer:User has provided mandatory information of its identity</li><li>Application developer has onboarded to MNO API</li><li>Application developer has API credentials</li><li>Privacy legal base requirement has been solved (Customer privacy) </li></ol>| | ||
| | ***Activities/Steps*** | **Starts when:** The customer application server makes a request to the KYC service (API) to confirm user identity.<br>**Ends when:** The MNO service returns matching result for each attribute of the customer identity.<br> | | ||
| | ***Post-conditions*** | The application developer can make decision to use this customer data to follow-up its process| | ||
| | ***Exceptions*** | Several exceptions might occur during the KYC Match API operations:<br><ul><li>Unauthorized: Not valid credentials (e.g. use of already expired access token).</li><li>Not Found: The number provided is not managed by the MNO</li><li>Invalid input: Not all mandatory input data to invoke operation (e.g. phone number).</li></ul>| | ||
|
|
||
| <br><br> | ||
|
|
||
| **User Story: KYC Fill-In - Get identity information of customer** | ||
| <br> | ||
|
|
||
| | **Item** | **Details** | | ||
| | ---- | ------- | | ||
| | ***Summary*** | As an application developer belonging to an enterprise, I want to retreive (using my application server/backend service) the identity information of a user by requesting the MNO to query information stored in its customer database. Information returned by the MNO are given name, family name, street address, city, country, region, postal code, birthdate, email address, etc. | | ||
| | ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Mobile Network Operators (MNO), hyperscalers, application developers, enterprise. <br> **Scope:** Any phone line (not limlited to 4G, 5G) | | ||
| | ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer:User has provided mandatory information of its identity</li><li>Application developer has onboarded to MNO API</li><li>Application developer has API credentials</li><li>Privacy legal base requirement has been solved (Customer privacy) </li></ol>| | ||
| | ***Activities/Steps*** | **Starts when:** The third party/enterprise customer application server makes a request to the KYC service (API) to retreive user identity information.<br>**Ends when:** The MNO service returns the identity information stored in its customer database.<br> | | ||
| | ***Post-conditions*** | The application developer uses this customer data to follow-up its process | | ||
| | ***Exceptions*** | Several exceptions might occur during the KYC Fill-in API operations:<br><ul><li>Unauthorized: Not valid credentials (e.g. use of already expired access token).</li><li>Not Found: The number provided is not managed by the MNO</li><li>Invalid input: Not all mandatory input data to invoke operation (e.g. phone number).</li></ul>| | ||
|
|
||
|
|
12 changes: 6 additions & 6 deletions
12
...PI-Readiness-Checklist_kyc-match-0.1.1.md → ...on/kyc-fill-in-API-Readiness-Checklist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,18 @@ | ||
| # API Readiness Checklist | ||
|
|
||
| Checklist for kyc-fill-in 0.1.1 in FALL24 | ||
| Checklist for kyc-fill-in 0.2.0-rc in release r1.1 | ||
|
|
||
| | Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Comments | | ||
| |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | ||
| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/kyc-fill-in.yaml) | | ||
| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/kyc-fill-in.yaml) | | ||
| | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | | ||
| | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | ||
| | 4 | API versioning convention applied | M | M | M | M | Y | | | ||
| | 5 | API documentation | M | M | M | M | Y | contained in API definition | | ||
| | 6 | User stories | O | O | O | M | Y | [link](documentation/API_documentation/Know%20Your%20Customer%20User%20Story.md) | | ||
| | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/kyc-fill-in.yaml) | | ||
| | 6 | User stories | O | O | O | M | Y | [link](documentation/API_documentation/KnowYourCustomer_User_Story.md) | | ||
| | 7 | Basic API test cases & documentation | O | M | M | M | N | to be provided | | ||
| | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | ||
| | 9 | Test result statement | O | O | O | M | N | | | ||
| | 10 | API release numbering convention applied | M | M | M | M | Y | | | ||
| | 11 | Change log updated | M | M | M | M | N | to be provided | | ||
| | 12 | Previous public release was certified | O | O | O | M | N | | | ||
| | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | ||
| | 12 | Previous public release was certified | O | O | O | M | N | | |
Oops, something went wrong.