Skip to content
New issue

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

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

Already on GitHub? # to your account

fix headings and reorg #66

Merged
merged 1 commit into from
Jan 6, 2025
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Financial Data Exchange (FDX) End to End Journey"
linkTitle: "Financial Data Exchange (FDX) End to End Journey"
title: "Financial Data Exchange (FDX) end to end journey"
linkTitle: "Financial Data Exchange (FDX) end to end journey"
weight: 5
date: 2023-03-15
---
Expand Down Expand Up @@ -73,6 +73,6 @@ Step 4: Request Data
* This is carried out by making a GET request the relevant resource.
* The unique AccountId(s) that are valid for the account-access-consent will be returned with a call to GET /accounts. This will always be the first call once an DR has a valid access token.

### Sequence Diagram
### Sequence diagram

![FDX End-to-end web journey sequence](/Images/FDX_Web_Journey_Sequence.svg)
4 changes: 2 additions & 2 deletions content/en/docs/Overview/Integration/mutual-auth.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Mutual authentication and certificate verification"
linkTitle: "Mutual Authentication"
linkTitle: "Mutual authentication"
weight: 2
date: 2021-06-22
type: sequence
---

Mutual Authentication is an important part of security in open banking. It is commonly implemented and is a component of Financial-grade API (FAPI).
Mutual authentication is an important part of security in open banking. It is commonly implemented and is a component of Financial-grade API (FAPI).

The flow is summarized as follows:

Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ This section provides a general overview of the solution. The goal is to provid

* A [solution overview](/docs/overview/solution) that describes the solution features.
* An [functional architecture](/docs/overview/integration) that shows a number of different flows.
* A [Consent Admin Dashboard Guide](/docs/overview/consent-admin-dashboard) that describes backoffice user interface.

<!-- * A [technical view](/docs/overview/technical) of the architecture and components. -->

Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/Overview/solution.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Solution Overview"
linkTitle: "Solution Overview"
title: "Solution overview"
linkTitle: "Solution overview"
weight: 1
date: 2021-06-22
---
Expand Down Expand Up @@ -43,7 +43,7 @@ We provide a comprehensive, pre-built catalog of the API Products available in t

Developer and Organization Onboarding is the ability to seamlessly onboard a developer or their organization.

#### Usage Plans and Subscriptions
#### Usage plans and subscriptions

Subscriptions are free or paid consumption options to access certain API from resources in products to help provide business case solutions. Consumers browse products, but must subscribe, request access, and be approved before products can be consumed with an application.

Expand All @@ -58,7 +58,7 @@ Development Tools are the affordances offered to developers to aid them in their
* Postman collections
* Interactive API explorers

#### Subscription, Application and API Usage
#### Subscription, application and API usage

Consumer insights provides API Consumers with secure, self-service access to actionable insights regarding their usage of the APIs from the Marketplace. Application and API usage analytics allow developers to understand the success of their applications.

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Validation/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Solution Validation"
title: "Solution validation"
linkTitle: "Validation"
weight: 10
date: 2021-09-02
Expand Down
9 changes: 9 additions & 0 deletions content/en/docs/api_security_guide/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "API Security Guide"
linkTitle: "API Security Guide"
weight: 17
---

This guide describes the security features implemented to protect the APIs offered by our solution.

Please make sure you are logged in to the Documentation portal before you click on a link below for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ weight: 12
date: 2024-11-29
---

This document provides an overview of the security mechanisms implemented to protect the APIs offered by our solution. These mechanisms ensure that sensitive data is exchanged securely and accessed only by authorized parties.
This guide provides an overview of the security mechanisms implemented to protect the APIs offered by our solution. These mechanisms ensure that sensitive data is exchanged securely and accessed only by authorized parties.

## Security Overview
## Security overview

Our API security framework incorporates industry-standard mechanisms to ensure robust protection:

Expand All @@ -16,9 +16,9 @@ Our API security framework incorporates industry-standard mechanisms to ensure r
* **JWT Tokens**: Provides secure, tamper-proof access tokens, ensuring only authorized entities can access the APIs.
* **FDX Security Guidelines**: Aligns with FDX standards for secure financial data exchange, ensuring compliance with industry best practices.

## Certificate-Based Authentication
## Certificate-based authentication

### TLS/SSL Encryption
### TLS/SSL encryption

All API communications are encrypted using **TLS (Transport Layer Security)**, safeguarding data against interception and tampering. SSL certificates are used to verify the authenticity and integrity of the communication between clients and servers.

Expand All @@ -31,7 +31,7 @@ To enhance security further, our APIs utilize **mutual TLS (mTLS)** for client a

Additionally, **certificate-bound access tokens** are employed to strengthen security by binding tokens to client certificates.

## Scope and Permissions
## Scope and permissions

Access to API resources is controlled through **scopes**, which define the permissions granted during authorization. The following table outlines available scopes and their corresponding access levels:

Expand All @@ -45,7 +45,7 @@ Access to API resources is controlled through **scopes**, which define the permi
| `fdx:paymentsupport:read` | Grants read access to payment-related data, including payment history and support-related information. |
| `fdx:transactions:read` | Grants read access to transaction data, including details on all transactions, such as amount, date, and status. |

## API Security, Scopes, and OAuth Protocols
## API security, scopes, and OAuth protocols

The tables below provides a summary of security measures, required scopes, and OAuth protocols for accessing API endpoints.

Expand Down Expand Up @@ -82,7 +82,7 @@ The following APIs are for Data Recipients and Data Aggregators to consume and b

### Solution APIs

The following APIs are for Data Providers to integrate with our consent managenent module.
The following APIs are for Data Providers to integrate with our consent management module.

#### External Resource Authentication API

Expand Down
9 changes: 9 additions & 0 deletions content/en/docs/consent_admin_dashboard_guide/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Consent Admin Dashboard Guide"
linkTitle: "Consent Admin Dashboard Guide"
weight: 16
---

This guide provides an overview and instructions for using the backoffice user interface for managing the consents of the customers initiated through the open banking channel.

Please click on a link below for more information
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Consent Admin Dashboard"
linkTitle: "Consent Admin Dashboard"
linkTitle: "Dashboard"
weight: 11
date: 2024-11-06
---
Expand All @@ -10,22 +10,22 @@ The Consent Admin Dashboard allows banks' back-office users to view and/or manag
* **View Access**: Allows the user to view data only.
* **Admin Access**: Enables the user to view and modify data.

## Dashboard Overview
## Dashboard overview

The dashboard displays all consent-related data in a table format, supporting features such as filtering and search. Users can filter the data by Status, Consent Type, and Owner, and perform a search by Consent ID at the top of the table.

![alt text](/Images/consent-admin/image-1.png)

## Features and Options
## Features and options

### Filter Options
### Filter options

* Users can filter the table data based on Status, Consent Type, and Owner.
* Multiple filters can be applied simultaneously.
* A **Reset** button is provided to restore filters to their default settings.
![alt text](/Images/consent-admin/image-2.png)

### Export Data
### Export data

* The dashboard allows users to export selected consent data by selecting specific rows using checkboxes, and then generating the export files of the chosen data.
![alt text](/Images/consent-admin/image-3.png)
Expand Down
Loading