This application demonstrates the lifecycle of KYC (Know Your Customer) data subscriptions. Financial institutions can acquire licenses to subscribe to data streams, periodically receiving tailored research on their customer. The research is configurable, and the institution can select the components of interest to include in the research, which is then verified both by a reviewer and by quality assurance. Until the license expires, they can observe live data streaming or report issues such as performance outage or stale data streams.
Disclaimer: This reference application is intended to demonstrate the capabilities of DAML. We recommend that you consider other non-functional aspects, such as security, resiliency, recoverability, etc., prior to production use.
Be sure you have the following installed:
- DAML SDK
- Docker
- Java
- Maven
Type:
mvn clean packageNote: If you change the DAML models locally, you need to re-run this command before starting the application.
Note: Make sure that you have built the application with Maven (see: Build with Maven).
There are two options:
- Type:
docker-compose up --build
- Open UI with a browser at http://localhost:7500.
- Start the DAML Sandbox and Navigator. Type:
The navigator will automatically open in new browser tab at http://localhost:7500.
daml start --sandbox-option --address=localhost --sandbox-option -w
- Start the automation logic by starting bots and the triggers. Type:
scripts/startTriggers.sh localhost 6865 target/know-your-customer.dar java -jar target/know-your-customer-0.0.1-SNAPSHOT.jar
- Stop the Docker containers or bots by typing Ctrl+C. (Alternatively, you can also stop it by typing
docker-compose down.)
- Stop the bots by typing Ctrl+C.
- Stop the Sandbox and the Navigator by typing Ctrl+C in the DAML assistant.
Reset the application by following these steps:
- Stop the app by following the steps in Stopping the App section.
- Start the app in Docker or Standalone by following the steps in the relevant section.
This User Guide will take you step-by-step through the process of subscribing to data streamed by publishers. It will lead you through all the major Navigator screens and data fields that you will need to use.
After working through these steps, you can use the Navigator interface to explore other functionality that is available in the application.
Note: This demo is designed to show a successful conclusion of the workflow without exceptions or error conditions. A full production implementation would include additional features, handle errors and exceptions, and incorporate appropriate security controls.
There are two fundamental role categories in the data streaming model: publisher and consumer. The publisher streams some data, observable by its consumers via their licenses. The diagram below shows the publisher-consumer relationships created by the market setup.
| Role | Responsibilities |
|---|---|
| Bank | Financial institution buying research on their customers. There are two banks: Bank1 and Bank2. |
| Provider | Provides raw customer data, initially read from a CSV file. There are three parties in this role: CDD_Provider, CIP_Provider, and ScreeningProvider. |
| Analyst | Collates raw research data streams, sends them through the review process (Reviewer and QA), and publishes the results for the banks. |
| Reviewer | Can review research composed by the Analyst. |
| QA | The gate keeper before publishing research. In most cases it simply accepts the review done by the Reviewer, but occasionally performs additional validation. |
| Operator | Represents the infrastructure. Operates model clock, builds relationships between parties, etc. |
When you launch KYC Data Service application, you will see the Navigator screen with the option to choose your role.
To log in:
- On the home screen, select the party from the list.
To switch users:
- Click the name of the current party at the top of the screen.
- On the home screen, select a different party.
Note: A convenient way to switch between parties is to open separate browsers, e.g., using a private browsing or incognito window.
For better interoperability and demo experience, the model time is emulated by contracts on the ledger. Therefore, the system time (coming from your operating system) and the model time (mainly used to make time-based decisions in the model) are separate concepts, including their speed. You can observe the model time as any party on the CurrentTime contract. You will also need to continue/stop/set time as the Operator to follow the demo workflow as described in the steps below.
The participants listed above in Roles and Responsibilities are added automatically at market setup along with other required reference data. The publisher-consumer relationships are also set up to ease license issuance. The raw data providers upload CSV content to publish data observations.
- Log in as Operator.
- Select the Time Management tab.
- Select the Time Manager contract.
- Select the choice Continue.
- Log in as KYC_Analyst.
- Select the Received KYC data tab (or the Provided KYC streams tab).
- Review the incoming (or outgoing) data that is displayed.
- Wait 5 seconds.
- Observe the updated data.
- (Optional) Check Include archived to see previously published data.
- Log in as Bank1.
- Select the Received KYC data tab.
- Review the incoming data that is displayed.
- Wait 5 seconds.
- Observe the updated data.
- Log in as Bank2.
- Select the Relationships tab.
- Select the contract where My Role is KYC data consumer.
- Select the choice RequestStandardAnnualStream.
- Fill the customer name: ACME.
- Select all inclusion: includeCIP, includeCDD, and includeScreening.
- Log in as KYC_Analyst.
- Select the KYC Requests tab.
- Select the Received DataStreamRequest contract.
- Select the choice DataStreamRequest_Propose.
- Fill the price, e.g.: 100
- Log in as Bank2.
- Select the KYC Price Proposals tab.
- Select the Received DataLicenseProposal contract.
- Select the choice DataLicenseProposal_Accept.
The KYC Licenses tab shows that the license automatically goes live as does the data stream (Received KYC data tab).
- Log in as Operator.
- Select the Time Management tab.
- Select the Time Manager contract.
- Select the choice Continue.
- Log in as Bank2.
- Select the Received KYC data tab.
- Review the incoming data showed.
- Wait 5 seconds.
- Observe the updated data.
- Log in as Operator.
- Select the Time Management tab.
- Select the Time Manager contract.
- Select the choice Stop.
- Log in as Bank1.
- Select the Received KYC data tab.
- Select the disputed Publication contract.
- Select the choice DisputeQuality.
- Fill the description, e.g.: The data seems to have issues
- Log in as KYC_Analyst or stay logged in as Bank1.
- Select the Complaints: Data Quality tab.
- Review the created complaints.
After completing the workflow, you can explore the application to try other paths or restart with a custom CSV, etc.
CONFIDENTIAL © 2020 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved. Any unauthorized use, duplication or distribution is strictly prohibited.