-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Create Bank Level Endpoint Tag
- Create System Level Endpoint Tag
- Delete Bank Level Endpoint Tag
- Delete System Level Endpoint Tag
- Get API Configuration
- Get API Info (root)
- Get Adapter Info
- Get Adapter Info for a bank
- Get Bank Level Endpoint Tags
- Get Connector Status (Loopback)
- Get JSON Web Key (JWK)
- Get JSON Web Key (JWK) URIs
- Get Mapper Database Info
- Get Rate Limiting Info
- Get Suggested Session Timeout
- Get System Level Endpoint Tags
- Get the Call Context of a current call
- Update Bank Level Endpoint Tag
- Update System Level Endpoint Tag
- Verify Request and Sign Response of a current call
- Waiting For Godot
-
-
ATM
- Create ATM
- Create ATM Attribute
- Delete ATM
- Delete ATM Attribute
- Get ATM Attribute By ATM_ATTRIBUTE_ID
- Get ATM Attributes
- Get Bank ATM
- Get Bank ATMS
- Head Bank ATMS
- UPDATE ATM
- Update ATM Accessibility Features
- Update ATM Attribute
- Update ATM Location Categories
- Update ATM Notes
- Update ATM Services
- Update ATM Supported Currencies
- Update ATM Supported Languages
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Check Available Funds
- Create Account (POST)
- Create Account (PUT)
- Create Account Attribute
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Access by USER_ID
- Get Account Attribute Definition
- Get Account Balances
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Core) through the VIEW_ID
- Get Account by Id (Full)
- Get Accounts Held
- Get Accounts Minimal for a Customer
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Accounts by Account Routing Regex
- Get Checkbook orders
- Get Fast Firehose Accounts at Bank
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
- Validate and check IBAN
-
-
Account Access
-
Account Access governs access to Bank Accounts by end Users. It is an intersecting entity between tMore...
- Create (DAuth) User with Account Access
- Grant User access to View
- Revoke User access to View
-
-
Api Collection
- Create My Api Collection
- Create My Api Collection Endpoint
- Create My Api Collection Endpoint By Id
- Delete My Api Collection
- Delete My Api Collection Endpoint
- Delete My Api Collection Endpoint By Id
- Delete My Api Collection Endpoint By Id
- Get All API Collections
- Get Api Collection Endpoints
- Get Api Collections for User
- Get Featured Api Collections
- Get My Api Collection By Id
- Get My Api Collection By Name
- Get My Api Collection Endpoint
- Get My Api Collection Endpoints
- Get My Api Collection Endpoints By Id
- Get My Api Collections
- Get Sharable Api Collection By Id
- Update My Api Collection By API_COLLECTION_ID
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Create Bank
- Create Bank Attribute
- Create Settlement Account
- Create Transaction Type at bank
- Create or Update Bank Attribute Definition
- Delete Bank Attribute
- Delete Bank Cascade
- Get Bank
- Get Bank Attribute By BANK_ATTRIBUTE_ID
- Get Bank Attributes
- Get Banks
- Get Settlement accounts at Bank
- Get Transaction Types at Bank
- Update Bank
- Update Bank Attribute
-
-
Connector Method
-
Developers can override all the existing Connector methods. This function needs to be used togethMore...
- Create Connector Method
- Get Connector Method by Id
- Get all Connector Methods
- Update Connector Method
-
-
Consent
-
Consents provide a mechanism by which a third party App or User can access resources on behalf of aMore...
- Add User to a Consent
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (IMPLICIT)
- Create Consent (SMS)
- Create Consent By CONSENT_REQUEST_ID (EMAIL)
- Create Consent By CONSENT_REQUEST_ID (IMPLICIT)
- Create Consent By CONSENT_REQUEST_ID (SMS)
- Create Consent Request
- Create Consent Request VRP
- Get Consent By Consent Id
- Get Consent By Consent Id
- Get Consent By Consent Request Id
- Get Consent Request
- Get Consents
- Get Consents Info
- Provide client's certificate info of a current call
- Revoke Consent
- Revoke Consent at Bank
- Revoke Consent used in the Current Call
- Update Consent Status
-
-
Consumer
-
The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on beMore...
- Enable or Disable Consumers
- Get Call Limits for a Consumer
- Get Consumer
- Get Consumers
- Get Consumers (logged in User)
- Post a Consumer
- Set Rate Limits / Call Limits per Consumer
- Update Consumer RedirectUrl
-
-
Counterparty
- Create Counterparty (Explicit)
- Create Counterparty for any account (Explicit)
- Delete Counterparty (Explicit)
- Delete Counterparty for any account (Explicit)
- Get Counterparties (Explicit)
- Get Counterparties for any account (Explicit)
- Get Counterparty by Id (Explicit)
- Get Counterparty by Id for any account (Explicit)
- Get Counterparty by name for any account (Explicit)
- Get Other Account by Id
- Get Other Accounts of one Account
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Customer
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- Create Address
- Create Customer
- Create Customer Account Link
- Create Customer Attribute
- Create Customer Social Media Handle
- Create Tax Residence
- Create User Customer Link
- Create or Update Customer Attribute Definition
- Delete Customer Account Link
- Delete Customer Address
- Delete Customer Attribute
- Delete Customer Attribute Definition
- Delete Customer Cascade
- Delete Tax Residence
- Delete User Customer Link
- Get CRM Events
- Get Correlated Entities for the current User
- Get Correlated User Info by Customer
- Get Customer Account Link by Id
- Get Customer Account Links by ACCOUNT_ID
- Get Customer Account Links by CUSTOMER_ID
- Get Customer Addresses
- Get Customer Attribute By Id
- Get Customer Attribute Definition
- Get Customer Attributes
- Get Customer Overview
- Get Customer Overview Flat
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers Minimal at Any Bank
- Get Customers Minimal at Bank
- Get Customers at Any Bank
- Get Customers at Bank
- Get Customers by MOBILE_PHONE_NUMBER
- Get Customers for Current User
- Get Customers for Current User (IDs only)
- Get Firehose Customers
- Get My Customers
- Get My Customers at Bank
- Get Tax Residences of Customer
- Get User Customer Links by Customer
- Get User Customer Links by User
- Update Customer Account Link by Id
- Update Customer Attribute
- Update the Address of a Customer
- Update the Branch of a Customer
- Update the credit limit of a Customer
- Update the credit rating and source of a Customer
- Update the email of a Customer
- Update the identity data of a Customer
- Update the mobile number of a Customer
- Update the number of a Customer
- Update the other data of a Customer
-
-
Dynamic Endpoint Manage
-
If you want to create endpoints from Swagger / Open API specification files, use Dynamic EndpointsMore...
- Delete Bank Level Dynamic Endpoint
- Delete Dynamic Endpoint
- Get Bank Level Dynamic Endpoint
- Get Dynamic Endpoints
- Update Bank Level Dynamic Endpoint Host
- Update Dynamic Endpoint Host
- Create Bank Level Dynamic Endpoint
- Create Dynamic Endpoint
- Delete My Dynamic Endpoint
- Get Bank Level Dynamic Endpoints
- Get Dynamic Endpoint
- Get My Dynamic Endpoints
-
-
Dynamic Entity Manage
-
Dynamic Entities can be used to store and retrieve custom data objects (think your own tables andMore...
- Create Bank Level Dynamic Entity
- Create System Level Dynamic Entity
- Delete Bank Level Dynamic Entity
- Delete My Dynamic Entity
- Delete System Level Dynamic Entity
- Get Bank Level Dynamic Entities
- Get My Dynamic Entities
- Get System Dynamic Entities
- Update Bank Level Dynamic Entity
- Update My Dynamic Entity
- Update System Level Dynamic Entity
-
-
Dynamic Message Doc
-
In OBP we represent messages sent by a Connector method / function as MessageDocs. A MessageDoc dMore...
- Create Bank Level Dynamic Message Doc
- Create Dynamic Message Doc
- Delete Bank Level Dynamic Message Doc
- Delete Dynamic Message Doc
- Get Bank Level Dynamic Message Doc
- Get Dynamic Message Doc
- Get all Bank Level Dynamic Message Docs
- Get all Dynamic Message Docs
- Update Bank Level Dynamic Message Doc
- Update Dynamic Message Doc
-
-
Dynamic Resource Doc
- A test endpoint
- Create Bank Level Dynamic Resource Doc
- Create Dynamic Resource Doc
- Create Dynamic Resource Doc endpoint code
- Delete Bank Level Dynamic Resource Doc
- Delete Dynamic Resource Doc
- Get Bank Level Dynamic Resource Doc by Id
- Get Dynamic Resource Doc by Id
- Get all Bank Level Dynamic Resource Docs
- Get all Dynamic Resource Docs
- Update Bank Level Dynamic Resource Doc
- Update Dynamic Resource Doc
-
Endpoint Mapping
-
Endpoint Mapping can be used to map each JSON field in a Dynamic Endpoint to different Dynamic EntiMore...
- Create Bank Level Endpoint Mapping
- Create Endpoint Mapping
- Delete Bank Level Endpoint Mapping
- Delete Endpoint Mapping
- Get Bank Level Endpoint Mapping
- Get Endpoint Mapping by Id
- Get all Bank Level Endpoint Mappings
- Get all Endpoint Mappings
- Update Bank Level Endpoint Mapping
- Update Endpoint Mapping
-
-
JSON Schema Validation
-
JSON Schema is "a vocabulary that allows you to annotate and validate JSON documents". By applyinMore...
- Create a JSON Schema Validation
- Delete a JSON Schema Validation
- Get a JSON Schema Validation
- Get all JSON Schema Validations
- Get all JSON Schema Validations - public
- Update a JSON Schema Validation
-
-
Method Routing
-
Open Bank Project can have different connectors, to connect difference data sources. We supportMore...
- Create MethodRouting
- Delete MethodRouting
- Get MethodRoutings
- Update MethodRouting
-
-
Product
- Create Product
- Create Product Attribute
- Create Product Fee
- Create or Update Product Attribute Definition
- Delete Product Attribute
- Delete Product Attribute Definition
- Delete Product Cascade
- Delete Product Fee
- Get Bank Product
- Get Product Attribute
- Get Product Attribute Definition
- Get Product Fee
- Get Product Fees
- Get Product Tree
- Get Products
- Update Product Attribute
- Update Product Fee
-
Role
- Add Entitlement for a User
- Create (DAuth) User with Roles
- Create Entitlement Request for current User
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User
- Get Entitlement Requests for the current User
- Get Entitlements and Permissions for a User
- Get Entitlements for One Bank
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Entitlements for the current User
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- Create Transaction Attribute
- Create or Update Transaction Attribute Definition
- Delete Transaction Attribute Definition
- Delete Transaction Cascade
- Get Balancing Transaction
- Get Double Entry Transaction
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction Attribute By Id
- Get Transaction Attribute Definition
- Get Transaction Attributes
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
- Update Transaction Attribute
-
-
Transaction Metadata
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction where Tag
-
Transaction Request
- Answer Transaction Request Challenge
- Create Historical Transactions
- Create Transaction Request (ACCOUNT)
- Create Transaction Request (ACCOUNT_OTP)
- Create Transaction Request (CARD)
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (REFUND)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Create Transaction Request (SIMPLE)
- Create Transaction Request Attribute
- Create or Update Transaction Request Attribute Definition
- Delete Transaction Request Attribute Definition
- Get Transaction Request
- Get Transaction Request Attribute By Id
- Get Transaction Request Attribute Definition
- Get Transaction Request Attributes
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
- Update Transaction Request Attribute
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- Answer User Auth Context Update Challenge
- Create My Personal User Attribute
- Create Non Personal User Attribute
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Create password reset url
- Delete Non Personal User Attribute
- Delete User Auth Context
- Delete User's Auth Contexts
- Delete a User
- Get Logout Link
- Get My Personal User Attributes
- Get My Spaces
- Get Non Personal User Attributes
- Get User (Current)
- Get User Auth Contexts
- Get User Id (Current)
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get User with Attributes by USER_ID
- Get Users by Email Address
- Get all Users
- Lock the user
- Refresh User
- Unlock the user
- Update My Personal User Attribute
-
-
API
- Create Bank Level Endpoint Tag
- Create System Level Endpoint Tag
- Delete Bank Level Endpoint Tag
- Delete System Level Endpoint Tag
- Get API Configuration
- Get API Info (root)
- Get Adapter Info
- Get Adapter Info for a bank
- Get Bank Level Endpoint Tags
- Get Connector Status (Loopback)
- Get JSON Web Key (JWK)
- Get JSON Web Key (JWK) URIs
- Get Mapper Database Info
- Get Rate Limiting Info
- Get Suggested Session Timeout
- Get System Level Endpoint Tags
- Get the Call Context of a current call
- Update Bank Level Endpoint Tag
- Update System Level Endpoint Tag
- Verify Request and Sign Response of a current call
- Waiting For Godot
-
ATM
- Create ATM
- Create ATM Attribute
- Delete ATM
- Delete ATM Attribute
- Get ATM Attribute By ATM_ATTRIBUTE_ID
- Get ATM Attributes
- Get Bank ATM
- Get Bank ATMS
- Head Bank ATMS
- UPDATE ATM
- Update ATM Accessibility Features
- Update ATM Attribute
- Update ATM Location Categories
- Update ATM Notes
- Update ATM Services
- Update ATM Supported Currencies
- Update ATM Supported Languages
-
Account
- Check Available Funds
- Create Account (POST)
- Create Account (PUT)
- Create Account Attribute
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Access by USER_ID
- Get Account Attribute Definition
- Get Account Balances
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Core) through the VIEW_ID
- Get Account by Id (Full)
- Get Accounts Held
- Get Accounts Minimal for a Customer
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Accounts by Account Routing Regex
- Get Checkbook orders
- Get Fast Firehose Accounts at Bank
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
- Validate and check IBAN
-
Account Access
-
Account Application
- Create Account Application
- Get Account Application by Id
- Get Account Applications
- Update Account Application Status
-
Account Metadata
-
Account Public
-
Api Collection
- Create My Api Collection
- Create My Api Collection Endpoint
- Create My Api Collection Endpoint By Id
- Delete My Api Collection
- Delete My Api Collection Endpoint
- Delete My Api Collection Endpoint By Id
- Delete My Api Collection Endpoint By Id
- Get All API Collections
- Get Api Collection Endpoints
- Get Api Collections for User
- Get Featured Api Collections
- Get My Api Collection By Id
- Get My Api Collection By Name
- Get My Api Collection Endpoint
- Get My Api Collection Endpoints
- Get My Api Collection Endpoints By Id
- Get My Api Collections
- Get Sharable Api Collection By Id
- Update My Api Collection By API_COLLECTION_ID
-
Authentication Type Validation
- Create an Authentication Type Validation
- Delete an Authentication Type Validation
- Get all Authentication Type Validations
- Get all Authentication Type Validations - public
- Get an Authentication Type Validation
- Update an Authentication Type Validation
-
Bank
- Create Bank
- Create Bank Attribute
- Create Settlement Account
- Create Transaction Type at bank
- Create or Update Bank Attribute Definition
- Delete Bank Attribute
- Delete Bank Cascade
- Get Bank
- Get Bank Attribute By BANK_ATTRIBUTE_ID
- Get Bank Attributes
- Get Banks
- Get Settlement accounts at Bank
- Get Transaction Types at Bank
- Update Bank
- Update Bank Attribute
-
Branch
-
Card
- Create Card
- Create Card Attribute
- Create or Update Card Attribute Definition
- Delete Card
- Delete Card Attribute Definition
- Get Card Attribute Definition
- Get Card By Id
- Get Cards for the specified bank
- Get cards for the current user
- Get status of Credit Card order
- Update Card
- Update Card Attribute
-
Connector Method
- Create Connector Method
- Get Connector Method by Id
- Get all Connector Methods
- Update Connector Method
-
Consent
- Add User to a Consent
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (IMPLICIT)
- Create Consent (SMS)
- Create Consent By CONSENT_REQUEST_ID (EMAIL)
- Create Consent By CONSENT_REQUEST_ID (IMPLICIT)
- Create Consent By CONSENT_REQUEST_ID (SMS)
- Create Consent Request
- Create Consent Request VRP
- Get Consent By Consent Id
- Get Consent By Consent Id
- Get Consent By Consent Request Id
- Get Consent Request
- Get Consents
- Get Consents Info
- Provide client's certificate info of a current call
- Revoke Consent
- Revoke Consent at Bank
- Revoke Consent used in the Current Call
- Update Consent Status
-
Consumer
- Enable or Disable Consumers
- Get Call Limits for a Consumer
- Get Consumer
- Get Consumers
- Get Consumers (logged in User)
- Post a Consumer
- Set Rate Limits / Call Limits per Consumer
- Update Consumer RedirectUrl
-
Counterparty
- Create Counterparty (Explicit)
- Create Counterparty for any account (Explicit)
- Delete Counterparty (Explicit)
- Delete Counterparty for any account (Explicit)
- Get Counterparties (Explicit)
- Get Counterparties for any account (Explicit)
- Get Counterparty by Id (Explicit)
- Get Counterparty by Id for any account (Explicit)
- Get Counterparty by name for any account (Explicit)
- Get Other Account by Id
- Get Other Accounts of one Account
-
Counterparty Limits
- Create Counterparty Limit
- Delete Counterparty Limit
- Get Counterparty Limit
- Update Counterparty Limit
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Customer
- Create Address
- Create Customer
- Create Customer Account Link
- Create Customer Attribute
- Create Customer Social Media Handle
- Create Tax Residence
- Create User Customer Link
- Create or Update Customer Attribute Definition
- Delete Customer Account Link
- Delete Customer Address
- Delete Customer Attribute
- Delete Customer Attribute Definition
- Delete Customer Cascade
- Delete Tax Residence
- Delete User Customer Link
- Get CRM Events
- Get Correlated Entities for the current User
- Get Correlated User Info by Customer
- Get Customer Account Link by Id
- Get Customer Account Links by ACCOUNT_ID
- Get Customer Account Links by CUSTOMER_ID
- Get Customer Addresses
- Get Customer Attribute By Id
- Get Customer Attribute Definition
- Get Customer Attributes
- Get Customer Overview
- Get Customer Overview Flat
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers Minimal at Any Bank
- Get Customers Minimal at Bank
- Get Customers at Any Bank
- Get Customers at Bank
- Get Customers by MOBILE_PHONE_NUMBER
- Get Customers for Current User
- Get Customers for Current User (IDs only)
- Get Firehose Customers
- Get My Customers
- Get My Customers at Bank
- Get Tax Residences of Customer
- Get User Customer Links by Customer
- Get User Customer Links by User
- Update Customer Account Link by Id
- Update Customer Attribute
- Update the Address of a Customer
- Update the Branch of a Customer
- Update the credit limit of a Customer
- Update the credit rating and source of a Customer
- Update the email of a Customer
- Update the identity data of a Customer
- Update the mobile number of a Customer
- Update the number of a Customer
- Update the other data of a Customer
-
Customer Meeting
-
Customer Message
- Create Customer Message
- Create Customer Message
- Get Customer Messages for a Customer
- Get Customer Messages for all Customers
-
Data Warehouse
-
Direct Debit
-
Directory
- Create Regulated Entity
- Create a Consumer
- Delete Regulated Entity
- Get Regulated Entities
- Get Regulated Entity
-
Documentation
- Get Bank Level Dynamic Resource Docs
- Get Glossary of the API
- Get Message Docs
- Get Message Docs Swagger
- Get Resource Docs
- Get Resource Docs
- Get Swagger documentation
- Get scanned API Versions
-
Dynamic Endpoint Manage
- Delete Bank Level Dynamic Endpoint
- Delete Dynamic Endpoint
- Get Bank Level Dynamic Endpoint
- Get Dynamic Endpoints
- Update Bank Level Dynamic Endpoint Host
- Update Dynamic Endpoint Host
- Create Bank Level Dynamic Endpoint
- Create Dynamic Endpoint
- Delete My Dynamic Endpoint
- Get Bank Level Dynamic Endpoints
- Get Dynamic Endpoint
- Get My Dynamic Endpoints
-
Dynamic Entity Manage
- Create Bank Level Dynamic Entity
- Create System Level Dynamic Entity
- Delete Bank Level Dynamic Entity
- Delete My Dynamic Entity
- Delete System Level Dynamic Entity
- Get Bank Level Dynamic Entities
- Get My Dynamic Entities
- Get System Dynamic Entities
- Update Bank Level Dynamic Entity
- Update My Dynamic Entity
- Update System Level Dynamic Entity
-
Dynamic Message Doc
- Create Bank Level Dynamic Message Doc
- Create Dynamic Message Doc
- Delete Bank Level Dynamic Message Doc
- Delete Dynamic Message Doc
- Get Bank Level Dynamic Message Doc
- Get Dynamic Message Doc
- Get all Bank Level Dynamic Message Docs
- Get all Dynamic Message Docs
- Update Bank Level Dynamic Message Doc
- Update Dynamic Message Doc
-
Dynamic Resource Doc
- A test endpoint
- Create Bank Level Dynamic Resource Doc
- Create Dynamic Resource Doc
- Create Dynamic Resource Doc endpoint code
- Delete Bank Level Dynamic Resource Doc
- Delete Dynamic Resource Doc
- Get Bank Level Dynamic Resource Doc by Id
- Get Dynamic Resource Doc by Id
- Get all Bank Level Dynamic Resource Docs
- Get all Dynamic Resource Docs
- Update Bank Level Dynamic Resource Doc
- Update Dynamic Resource Doc
-
Endpoint Mapping
- Create Bank Level Endpoint Mapping
- Create Endpoint Mapping
- Delete Bank Level Endpoint Mapping
- Delete Endpoint Mapping
- Get Bank Level Endpoint Mapping
- Get Endpoint Mapping by Id
- Get all Bank Level Endpoint Mappings
- Get all Endpoint Mappings
- Update Bank Level Endpoint Mapping
- Update Endpoint Mapping
-
FX
-
JSON Schema Validation
- Create a JSON Schema Validation
- Delete a JSON Schema Validation
- Get a JSON Schema Validation
- Get all JSON Schema Validations
- Get all JSON Schema Validations - public
- Update a JSON Schema Validation
-
KYC
- Add KYC Check
- Add KYC Document
- Add KYC Media
- Add KYC Status
- Get Customer KYC Checks
- Get Customer KYC Documents
- Get Customer KYC statuses
- Get KYC Media for a customer
-
Method Routing
-
Metric
- Get Aggregate Metrics
- Get Connector Metrics
- Get Metrics
- Get Metrics at Bank
- Get Top APIs
- Get Top Consumers
- Search API Metrics via Elasticsearch
-
Product
- Create Product
- Create Product Attribute
- Create Product Fee
- Create or Update Product Attribute Definition
- Delete Product Attribute
- Delete Product Attribute Definition
- Delete Product Cascade
- Delete Product Fee
- Get Bank Product
- Get Product Attribute
- Get Product Attribute Definition
- Get Product Fee
- Get Product Fees
- Get Product Tree
- Get Products
- Update Product Attribute
- Update Product Fee
-
Product Collection
-
Role
- Add Entitlement for a User
- Create (DAuth) User with Roles
- Create Entitlement Request for current User
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User
- Get Entitlement Requests for the current User
- Get Entitlements and Permissions for a User
- Get Entitlements for One Bank
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Entitlements for the current User
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
-
Sandbox
-
Scope
-
Standing Order
-
System Integrity
- Check Custom View Names
- Check System View Names
- Check Unique Index at Account Access
- Check for Orphaned Accounts
- Check for Sensible Currencies
-
Transaction
- Create Transaction Attribute
- Create or Update Transaction Attribute Definition
- Delete Transaction Attribute Definition
- Delete Transaction Cascade
- Get Balancing Transaction
- Get Double Entry Transaction
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction Attribute By Id
- Get Transaction Attribute Definition
- Get Transaction Attributes
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
- Update Transaction Attribute
-
Transaction Metadata
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction where Tag
-
Transaction Request
- Answer Transaction Request Challenge
- Create Historical Transactions
- Create Transaction Request (ACCOUNT)
- Create Transaction Request (ACCOUNT_OTP)
- Create Transaction Request (CARD)
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (REFUND)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Create Transaction Request (SIMPLE)
- Create Transaction Request Attribute
- Create or Update Transaction Request Attribute Definition
- Delete Transaction Request Attribute Definition
- Get Transaction Request
- Get Transaction Request Attribute By Id
- Get Transaction Request Attribute Definition
- Get Transaction Request Attributes
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
- Update Transaction Request Attribute
-
User
- Answer User Auth Context Update Challenge
- Create My Personal User Attribute
- Create Non Personal User Attribute
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Create password reset url
- Delete Non Personal User Attribute
- Delete User Auth Context
- Delete User's Auth Contexts
- Delete a User
- Get Logout Link
- Get My Personal User Attributes
- Get My Spaces
- Get Non Personal User Attributes
- Get User (Current)
- Get User Auth Contexts
- Get User Id (Current)
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get User with Attributes by USER_ID
- Get Users by Email Address
- Get all Users
- Lock the user
- Refresh User
- Unlock the user
- Update My Personal User Attribute
-
User Invitation
-
View Custom
- Create Custom View
- Create Custom View
- Delete Custom View
- Delete Custom View
- Get Account access for User
- Get Custom View
- Get Views for Account
- Get access
- Update Custom View
- Update Custom View
-
View System
-
WebUi Props
-
Webhook
- Create an Account Webhook
- Create bank level Account Notification Webhook
- Create system level Account Notification Webhook
- Enable/Disable an Account Webhook
- Get Account Webhooks
v5.1.0 (529 APIs)
Get Aggregate Metrics
Returns aggregate metrics on api usage eg. total count, response time (in ms), etc.
Should be able to filter on the following fields
eg: /management/aggregate-metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&consumer_id=5
&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
&verb=GET&anon=false&app_name=MapperPostman
&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
1 from_date (defaults to the day before the current date): eg:from_date=1100-01-01T01:01:01.000Z
2 to_date (defaults to the current date) eg:to_date=1100-01-01T01:01:01.000Z
3 consumer_id (if null ignore)
4 user_id (if null ignore)
5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
6 url (if null ignore), note: can not contain '&'.
7 app_name (if null ignore)
8 implemented_by_partial_function (if null ignore),
9 implemented_in_version (if null ignore)
10 verb (if null ignore)
11 correlation_id (if null ignore)
12 include_app_names (if null ignore).eg: &include_app_names=API-EXPLORER,API-Manager,SOFI,null
13 include_url_patterns (if null ignore).you can design you own SQL LIKE pattern. eg: &include_url_patterns=%management/metrics%,%management/aggregate-metrics%
14 include_implemented_by_partial_functions (if null ignore).eg: &include_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
Authentication is Mandatory
JSON response body fields:
{
"count":7076,
"average_response_time":65.21,
"minimum_response_time":1.0,
"maximum_response_time":9039.0
}
-
CanReadAggregateMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Connector Metrics
Get the all metrics
require CanGetConnectorMetrics role
Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics
Should be able to filter on the following metrics fields
eg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
3 limit (for pagination: defaults to 1000) eg:limit=2000
4 offset (for pagination: zero index, defaults to 0) eg: offset=10
eg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=100&offset=300
Other filters:
5 connector_name (if null ignore)
6 function_name (if null ignore)
7 correlation_id (if null ignore)
Authentication is Mandatory
JSON response body fields:
correlation_id: 1flssoftxq0cr1nssr68u0mioj
date: 2020-01-27
duration: 5.123
{
"metrics":[{
"connector_name":"mapper",
"function_name":"getBanks",
"correlation_id":"12345",
"date":"1100-01-01T00:00:00Z",
"duration":1000
}]
}
-
CanGetConnectorMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10005: Invalid Date Format. Could not convert value to a Date.
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
Get Metrics
Get API metrics rows. These are records of each REST API call.
require CanReadMetrics role
Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
You can filter by the following fields by applying url parameters
eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
1 from_date e.g.:from_date=1100-01-01T01:01:01.000Z Defaults to the Unix Epoch i.e. Thu Jan 01 00:00:00 UTC 1970
2 to_date e.g.:to_date=1100-01-01T01:01:01.000Z Defaults to a far future date i.e. Sat Jan 01 00:00:00 UTC 4000
Note: it is recommended you send a valid from_date (e.g. 5 seconds ago) and to_date (now + 1 second) if you want to get the latest records
Otherwise you may receive stale cached results.
3 limit (for pagination: defaults to 50) eg:limit=200
4 offset (for pagination: zero index, defaults to 0) eg: offset=10
5 sort_by (defaults to date field) eg: sort_by=date
possible values:
"url",
"date",
"user_name",
"app_name",
"developer_email",
"implemented_by_partial_function",
"implemented_in_version",
"consumer_id",
"verb"
6 direction (defaults to date desc) eg: direction=desc
eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
Other filters:
7 consumer_id (if null ignore)
8 user_id (if null ignore)
9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
10 url (if null ignore), note: can not contain '&'.
11 app_name (if null ignore)
12 implemented_by_partial_function (if null ignore),
13 implemented_in_version (if null ignore)
14 verb (if null ignore)
15 correlation_id (if null ignore)
16 duration (if null ignore) non digit chars will be silently omitted
Authentication is Mandatory
JSON response body fields:
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
correlation_id: 1flssoftxq0cr1nssr68u0mioj
date: 2020-01-27
duration: 5.123
implemented_by_partial_function:
response_body: response_body
source_ip: source_ip
target_ip: target_ip
url: http://www.example.com/id-docs/123/image.png
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
user_name: felixsmith
verb:
{
"metrics":[{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"url":"www.openbankproject.com",
"date":"1100-01-01T00:00:00Z",
"user_name":"OBP",
"app_name":"SOFI",
"developer_email":"felixsmith@example.com",
"implemented_by_partial_function":"getBanks",
"implemented_in_version":"v210",
"consumer_id":"123",
"verb":"get",
"correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1",
"duration":39,
"source_ip":"2001:0db8:3c4d:0015:0000:0000:1a2f:1a2b",
"target_ip":"2001:0db8:3c4d:0015:0000:0000:1a2f:1a2b",
"response_body":{
"code":401,
"message":"OBP-20001: User not logged in. Authentication is required!"
}
}]
}
-
CanReadMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Metrics at Bank
Get the all metrics at the Bank specified by BANK_ID
require CanReadMetrics role
Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
Should be able to filter on the following metrics fields
eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
3 limit (for pagination: defaults to 50) eg:limit=200
4 offset (for pagination: zero index, defaults to 0) eg: offset=10
5 sort_by (defaults to date field) eg: sort_by=date
possible values:
"url",
"date",
"user_name",
"app_name",
"developer_email",
"implemented_by_partial_function",
"implemented_in_version",
"consumer_id",
"verb"
6 direction (defaults to date desc) eg: direction=desc
eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
Other filters:
7 consumer_id (if null ignore)
8 user_id (if null ignore)
9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
10 url (if null ignore), note: can not contain '&'.
11 app_name (if null ignore)
12 implemented_by_partial_function (if null ignore),
13 implemented_in_version (if null ignore)
14 verb (if null ignore)
15 correlation_id (if null ignore)
16 duration (if null ignore) non digit chars will be silently omitted
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
correlation_id: 1flssoftxq0cr1nssr68u0mioj
date: 2020-01-27
duration: 5.123
implemented_by_partial_function:
url: http://www.example.com/id-docs/123/image.png
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
user_name: felixsmith
verb:
{
"metrics":[{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"url":"www.openbankproject.com",
"date":"1100-01-01T00:00:00Z",
"user_name":"OBP",
"app_name":"SOFI",
"developer_email":"felixsmith@example.com",
"implemented_by_partial_function":"getBanks",
"implemented_in_version":"v210",
"consumer_id":"123",
"verb":"get",
"correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1",
"duration":39
}]
}
-
CanGetMetricsAtOneBank
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Top APIs
Get metrics about the most popular APIs. e.g.: total count, response time (in ms), etc.
Should be able to filter on the following fields
eg: /management/metrics/top-apis?from_date=1970-01-01T00:00:00.000Z&to_date=2024-11-03T21:00:56.421Z&consumer_id=5
&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
&verb=GET&anon=false&app_name=MapperPostman
&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
1 from_date (defaults to the one year ago): eg:from_date=1970-01-01T00:00:00.000Z
2 to_date (defaults to the current date) eg:to_date=2024-11-03T21:00:56.421Z
3 consumer_id (if null ignore)
4 user_id (if null ignore)
5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
6 url (if null ignore), note: can not contain '&'.
7 app_name (if null ignore)
8 implemented_by_partial_function (if null ignore),
9 implemented_in_version (if null ignore)
10 verb (if null ignore)
11 correlation_id (if null ignore)
12 duration (if null ignore) non digit chars will be silently omitted
13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
Authentication is Mandatory
JSON response body fields:
{
"top_apis":[{
"count":7076,
"Implemented_by_partial_function":"getBanks",
"implemented_in_version":"v1.2.1"
}]
}
-
CanReadMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10016: Incorrect filter Parameters in URL.
- OBP-30042: Could not get the top apis from database.
- OBP-50000: Unknown Error.
Get Top Consumers
Get metrics about the top consumers of the API usage e.g. total count, consumer_id and app_name.
Should be able to filter on the following fields
e.g.: /management/metrics/top-consumers?from_date=1970-01-01T00:00:00.000Z&to_date=2024-11-03T21:00:56.422Z&consumer_id=5
&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
&verb=GET&anon=false&app_name=MapperPostman
&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
&limit=100
1 from_date (defaults to the one year ago): eg:from_date=1970-01-01T00:00:00.000Z
2 to_date (defaults to the current date) eg:to_date=2024-11-03T21:00:56.422Z
3 consumer_id (if null ignore)
4 user_id (if null ignore)
5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
6 url (if null ignore), note: can not contain '&'.
7 app_name (if null ignore)
8 implemented_by_partial_function (if null ignore),
9 implemented_in_version (if null ignore)
10 verb (if null ignore)
11 correlation_id (if null ignore)
12 duration (if null ignore) non digit chars will be silently omitted
13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
16 limit (for pagination: defaults to 50) eg:limit=200
Authentication is Mandatory
JSON response body fields:
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
{
"top_consumers":[{
"count":7076,
"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"app_name":"Api Explorer",
"developer_email":"felixsmith@example.com"
}]
}
-
CanReadMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10016: Incorrect filter Parameters in URL.
- OBP-30045: Could not get the top consumers from database.
- OBP-50000: Unknown Error.
Search API Metrics via Elasticsearch
Search the API calls made to this API instance via Elastic Search.
Login is required.
CanSearchMetrics entitlement is required to search metrics data.
parameters:
esType - elasticsearch type
simple query:
q - plain_text_query
df - default field to search
sort - field to sort on
size - number of hits returned, default 10
from - show hits starting from
json query:
source - JSON_query_(URL-escaped)
example usage:
/search/metrics/q=findThis
or:
/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}
Note!!
The whole JSON query string MUST be URL-encoded:
- For { use %7B
- For } use %7D
- For : use %3A
- For " use %22
etc..
Only q, source and esType are passed to Elastic
Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
Authentication is Mandatory
JSON response body fields:
none:
{
}
-
CanSearchMetrics
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.