https://github.com/mastercard/mastercard-idservice-tp-reference-app
https://github.com/mastercard/mastercard-idservice-tp-reference-app
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/mastercard/mastercard-idservice-tp-reference-app
- Owner: Mastercard
- License: apache-2.0
- Created: 2022-09-14T14:57:26.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-07T19:02:21.000Z (over 2 years ago)
- Last Synced: 2024-04-16T10:43:18.013Z (over 2 years ago)
- Language: Java
- Size: 243 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ID for Trust Providers Reference Implementation
[](https://developer.mastercard.com/)
[](./LICENSE)
[](https://sonarcloud.io/summary/new_code?id=Mastercard_mastercard-idservice-tp-reference-app)
[](https://sonarcloud.io/summary/new_code?id=Mastercard_mastercard-idservice-tp-reference-app)
[](https://sonarcloud.io/summary/new_code?id=Mastercard_mastercard-idservice-tp-reference-app)
## Table of Contents
- [Overview](#overview)
* [References](#references)
- [Usage](#usage)
* [Prerequisites](#prerequisites)
* [Configuration](#configuration)
* [Integrating with OpenAPI Generator](#integrating-with-openapi-generator)
* [OpenAPI Generator Plugin Configuration](#openapi-generator-plugin-configuration)
* [Generating The API Client Sources](#generating-the-api-client-sources)
* [Running the Project](#running-the-project)
* [Use Cases](#use-cases)
* [Execute the Use-Cases](#execute-use-cases)
- [API Reference](#api-reference)
* [Request Examples](#request-examples)
- [Support](#support)
## Overview
ID for Trust Providers is a digital identity service from Mastercard that helps you apply for, enroll in, log in to, and access services more simply, securely and privately. Rather than manually providing your information when you are trying to complete tasks online or in apps, ID enables you to share your verified information automatically, more securely, and with your consent and control. ID also enables you to do away with passwords and protects your personal information. Please see here for more details on the API: [ID for Trust Providers](https://developer.mastercard.com/mastercard-id-for-tp/documentation/).
For more information regarding the program, refer to [ID Service](https://idservice.com/)
### References
* [Mastercard's OAuth Signer library](https://github.com/Mastercard/oauth1-signer-java)
* [Using OAuth 1.0a to Access Mastercard APIs](https://developer.mastercard.com/platform/documentation/using-oauth-1a-to-access-mastercard-apis/)
* [Mastercard's Payload Encryption/Decryption library](https://github.com/Mastercard/client-encryption-java)
* [Using Payload Encryption](https://developer.mastercard.com/platform/documentation/security-and-authentication/securing-sensitive-data-using-payload-encryption/)
## Usage
### Prerequisites
* [Mastercard Developers Account](https://developer.mastercard.com/dashboard) with access to ID for Trust Providers API
* IntelliJ IDEA (or any other IDE)
* [Spring Boot 2.2+ up to 2.7.x](https://spring.io/projects/spring-boot)
* [Apache Maven 3.3+](https://maven.apache.org/download.cgi)
* [Java 8 or later is installed](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
* Set up the `JAVA_HOME` environment variable to match the location of your Java installation
1. Create an account at [Mastercard Developers](https://developer.mastercard.com/account/sign-up).
2. Create a new project and add `ID for Trust Providers` API to your project.
3. Download Sandbox Signing Key, a .p12 file will be downloaded.
4. In the Client Encryption Keys section of the dashboard, click on the `Actions` dropdown and download the client encryption key, a `.pem` file will be downloaded.
5. Select all `.p12` and `.pem` files, and copy them to `src/main/resources` in the project folder.
6. Open `${project.basedir}/src/main/resources/application.properties` and configure the below parameters.
**Authentication**
>**mastercard.api.key.file=classpath:** Path to keystore (.p12) file, just change the name as per the downloaded file in step 5 and set value as "classpath:your-Mastercard_ID_Service_MTF-sandbox.p12"
>**mastercard.api.consumer.key=** This refers to your consumer key. Copy it from the "Keys" section on your project page in [Mastercard Developers](https://developer.mastercard.com/dashboard).
>**mastercard.api.keystore.alias=** Alias of your key. Default key alias for sandbox is `keyalias`.
>**mastercard.api.keystore.password=** Password of your Keystore. Default keystore password for sandbox project is `keystorepassword`.
>**mastercard.user.selectedCountry=** Replace this country code as required. Following ISO 3166-1 alpha-3 standard. Example: USA.
>**mastercard.client.userProfileId=** This will be used by /user-profiles API to register a user profile using the given userProfileId. An error will be returned if the user profile already exists.
>**mastercard.client.enrollment.workflowId=** This workflowId is created by the identity verification provider during the enrollment of the user, and it will be used by other APIs to retrieve the extracted data of the document in a subsequent call.
>**mastercard.client.sessionId=** This sessionId is the tpAuditMetadata sessionId from the client.
>**mastercard.client.transactionGroupId=** This is the tpAuditMetadata transactionGroupId from the client.
**Encryption**
>**mastercard.api.encryption.certificateFile=classpath:** Copy your downloaded certificate (.pem) file to src/main/resources and set value as "classpath:your-mastercard-ID-ServiceClientEnc.pem"
>**mastercard.api.encryption.fingerPrint=** Fingerprint, copy this from the "Client Encryption Keys" section on your project page in [Mastercard Developers](https://developer.mastercard.com/dashboard).
**Decryption**
>**mastercard.api.decryption.keystore=classpath:** Copy your downloaded .p12 file to src/main/resources and set value as "classpath:keyalias-encryption-mc.p12"
>**mastercard.api.decryption.alias=** Alias of your key. Default key alias for sandbox is `keyalias`.
>**mastercard.api.decryption.keystore.password=** Password of your Keystore. Default keystore password for sandbox project is `keystorepassword`.
>**server.port=** Application port.
>**mastercard.api.pds.update.conflict.attribute=** Replace this value with "FATHERS_NAME" or "MOTHERS_NAME" or "LEGAL_NAME". More information about it. Please search for IdentityAttributeItem at the mids-reference-app-spec.yaml file.
>**mastercard.api.pds.update.conflict.attribute.value=** This name should be present in one of the scanned documents(Drivers License or Passport).
>**mastercard.api.scanID=** Replace this value with updated value.
>**api.session.token=** Replace this value with X-user-identity obtained for the user profileID.
### Integrating with OpenAPI Generator
[OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) generates API client libraries from [OpenAPI Specs](https://github.com/OAI/OpenAPI-Specification).
It provides generators and library templates for supporting multiple languages and frameworks.
See also:
* [OpenAPI Generator (maven Plugin)](https://mvnrepository.com/artifact/org.openapitools/openapi-generator-maven-plugin)
* [OpenAPI Generator (executable)](https://mvnrepository.com/artifact/org.openapitools/openapi-generator-cli)
* [CONFIG OPTIONS for java](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/java.md)
#### OpenAPI Generator Plugin Configuration
```xml
org.openapitools
openapi-generator-maven-plugin
${openapi-generator.version}
generate
${project.basedir}/src/main/resources/mastercard-idservice-reference_api_spec.yaml
java
okhttp-gson
false
false
src/gen/main/java
java8
```
#### Generating The API Client Sources
Now that you have all the required dependencies, you can generate the sources. To do this, use one of the following methods:
* **Using IDE**
In IntelliJ IDEA (or any other IDE of your choice), open the Maven menu. Click the icons `Reimport All Maven Projects` and `Generate Sources and Update Folders for All Projects`.
* **Using Terminal or CMD**
Navigate to the project's root directory within a terminal window and execute the `mvn clean compile` command.
* **VM Parameter for country selection**
Pass VM Options for `userSelectedCountry`. `USA` set as default.
Example: `-DuserSelectedCountry=BRA`
* **Using IDE**
Navigate to the `com.mastercard.dis.mids.reference` package and right-click to run `MIDSReferenceApplication`
* **Using Terminal or CMD**
Navigate to the project's root directory within a terminal window and execute the `mvn spring-boot:run` command.
* After that you can see all the menu options, such as:
1. Registering a User Profile
2. Access Token API (SDKToken)
3. Create User Identity
4. Multi-Access Token API (MultiSDKToken)
5. Access User Identity
6. Update ID Confirmations (Enrollment)
7. Update ID Confirmations (Re-authentication)
8. User Account Activity Searches
9. Email OTP
10. SMS OTP
11. User Profiles Identity Searches
12. Share User Identity (TP-TP)
13. RP Activity Searches
14. Audit Events
15. Delete ID
16. Share User Identity (TP-RP) (Enrollment)
17. Additional Document Support
18. Share User Identity (TP-RP) (Re-authentication)
19. TP Scopes
20. TP Data Shares
21. Update Identity
22. Delete Identity Attribute
23. Authentication Decisions
24. Exit
### Use cases
The main use cases in ID for Trust Providers Reference APIs are Personal Data Storage, SMS One Time Password, Email One Time Password, Document Verification, Multi Document Verification, Re-Authentication, GPA-Authentication, Claims Sharing, Audit Events, User Profile, Delete ID, TP Scopes Request and Fraud Data.
More details can be found [here](https://developer.mastercard.com/mastercard-id-for-tp/documentation/use-cases/).
### Execute the Use-Cases
1. Run mvn clean install from the root of the project directory.
2. There are two ways to execute the user cases :
1. Execute the test cases
- At the `src/test/java` which is the main root folder for all Junit tests of the application.
- Run the tests.
2. Select the menu options provided by the application
- Run ```mvn spring-boot:run``` command to run the application.
- Once the application is running, you should be able chose the options.
- To develop a client application that consumes the ID for Trust Providers API with Spring Boot, refer to the [ID for Trust Providers Reference](https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-reference/).
- The OpenAPI specification with `idservice` endpoints can be found [here](https://developer.mastercard.com/mastercard-id-for-tp/documentation/reference-app/).
### Request Examples
You can change the default input passed to APIs, modify values in following file:
* `com.mastercard.dis.mids.reference.constants.Constants`
- For further information, send an e-mail to `apisupport@mastercard.com`.
- For information regarding licensing, refer to the [LICENSE](LICENSE.md).
- For copyright information, refer to the [COPYRIGHT](COPYRIGHT.md).
- For instructions on how to contribute to this project, refer to the [CONTRIBUTING](CONTRIBUTING.md).
- For changelog information, refer to the [CHANGELOG](CHANGELOG.md).