Skip to content

Commit

Permalink
1.18.0 - new API endpoint and Documentation update
Browse files Browse the repository at this point in the history
Added get customer authorization API
Added new field distputeStatement to Reports
webSDK Parameter documentation updates
GetReports API documentation updates
  • Loading branch information
Jadavpadma authored Jun 20, 2024
1 parent eea62f8 commit a9031c8
Showing 1 changed file with 25 additions and 12 deletions.
37 changes: 25 additions & 12 deletions openbanking-us.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -492,16 +492,18 @@ paths:
delete:
tags:
- Customers
summary: Delete Customer by ID
summary: Delete Access to Customer by ID
description: >-
Completely remove a customer from the system. This will remove the
customer and all associated accounts and transactions.
Delete access to a customer and all associated accounts.

This will delete access to the customer and all their linked accounts.
The customer data will no longer be accessible. Any customer data
already collected will be retained in accordance with our enterprise
data retention policy consistent with legal and business purposes.

⚠️ Use this service carefully! It will not pause for confirmation before
performing the operation!


_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)
operationId: DeleteCustomer
parameters:
Expand Down Expand Up @@ -725,11 +727,15 @@ paths:
delete:
tags:
- Accounts
summary: Delete Customer Accounts by Institution Login ID
summary: Delete Access to Customer Accounts by Institution Login ID
description: >-
Remove from Finicity aggregation the set of accounts matching the
institution login ID.
Delete access to all customer accounts for a given FI.​

This will delete access to the underlying account(s) under a given
Institution Login ID. The customer data will no longer be accessible.
Any customer data already collected will be retained in accordance with
our enterprise retention policy consistent with legal and business
purposes.

_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)
operationId: DeleteCustomerAccountsByInstitutionLogin
Expand Down Expand Up @@ -772,10 +778,17 @@ paths:
delete:
tags:
- Accounts
summary: Delete Customer Account by ID
summary: Delete Access to Customer Account by ID
description: >-
Remove the given account from Finicity aggregation.
This will delete access to a specific account only. If the given account
is not the last account, then partners and their customers will have the
flexibility to continue to access data from other connected accounts
using the consented (Oauth) token for the customer.

The customer data on that specific account will no longer be accessible.
Any customer data already collected will be retained in accordance with
our enterprise retention policy consistent with legal and business
purposes. ​

_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)
operationId: DeleteCustomerAccount
Expand Down Expand Up @@ -3990,7 +4003,7 @@ components:
ModifyCustomerResponse:
description: The customer was successfully updated
DeleteCustomerResponse:
description: The customer was successfully deleted
description: Access to the customer was successfully removed
CreateConsumerResponse:
description: The consumer was successfully created
content:
Expand Down Expand Up @@ -4038,9 +4051,9 @@ components:
RefreshCustomerV2AccountsResponse:
description: The account list was successfully refreshed
DeleteCustomerAccountsByInstitutionLoginResponse:
description: The customer accounts were successfully deleted
description: Access to the customer accounts was successfully removed
DeleteCustomerAccountResponse:
description: The customer account was successfully deleted
description: Access to the customer account was successfully removed
LoadHistoricTransactionsForCustomerAccountResponse:
description:
Historic transactions have been loaded successfully. The transactions
Expand Down

0 comments on commit a9031c8

Please sign in to comment.