-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Get API Configuration
- Get API Info (root)
- Get Adapter Info for a bank
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Create Account
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Held
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Firehose Accounts at Bank
- Update Account Label
-
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Create Bank
- Create Transaction Type at bank
- Get Bank
- Get Banks
- Get Transaction Types at Bank
-
-
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 Consumer
- Get Consumers
- Update Consumer RedirectUrl
-
-
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 Customer
- Create Customer Social Media Handle
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get Customers for Current User
- Get Customers for current User at Bank
-
-
Role
- Add Entitlement for a User
- 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 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...
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
-
-
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
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- Create User
- Get User (Current)
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
-
-
_Book Mark Bank And Account System
- Create new Book Mark Bank And Account System
- Create new My Book Mark Bank And Account System
- Delete Book Mark Bank And Account System by id
- Delete My Book Mark Bank And Account System by id
- Get Book Mark Bank And Account System List
- Get Book Mark Bank And Account System by id
- Get My Book Mark Bank And Account System List
- Get My Book Mark Bank And Account System by id
- Update Book Mark Bank And Account System
- Update My Book Mark Bank And Account System
-
_Book Mark Bank And Account(Gen1 Aeena)
- Create new Book Mark Bank And Account
- Create new My Book Mark Bank And Account
- Delete Book Mark Bank And Account by id
- Delete My Book Mark Bank And Account by id
- Get Book Mark Bank And Account List
- Get Book Mark Bank And Account by id
- Get My Book Mark Bank And Account List
- Get My Book Mark Bank And Account by id
- Update Book Mark Bank And Account
- Update My Book Mark Bank And Account
-
API
-
ATM
-
Account
- Create Account
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Held
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Firehose Accounts at Bank
- Update Account Label
-
Account Public
-
Bank
-
Branch
-
Card
-
Consumer
-
Counterparty
- Create Counterparty (Explicit)
- Get Counterparties (Explicit)
- Get Counterparty by Counterparty Id (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
- Create Customer
- Create Customer Social Media Handle
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get Customers for Current User
- Get Customers for current User at Bank
-
Customer Message
-
Data Warehouse
-
Documentation
- Get Bank Level Dynamic Resource Docs
- Get Glossary of the API
- Get Message Docs
- Get Resource Docs
- Get Resource Docs
- Get Swagger documentation
-
Dynamic Resource Doc
-
Example test Title
-
FX
-
JOPACC ATM TEST service
-
JOPACC TEST ATM 2 service
-
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
-
Metric
-
Product
-
Role
- Add Entitlement for a User
- 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 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
-
Swagger Petstore OpenAPI 3.1
-
Transaction
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
-
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 Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
-
User
- Create User
- Get User (Current)
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
-
View Custom
- Create Custom View
- Delete Custom View
- Get Account access for User
- Get Views for Account
- Get access
- Grant User access to View
- Grant User access to a list of views
- Revoke access to all Views on Account
- Revoke access to one View
- Update Custom View
-
_Book Mark Bank And Account System
- Create new Book Mark Bank And Account System
- Create new My Book Mark Bank And Account System
- Delete Book Mark Bank And Account System by id
- Delete My Book Mark Bank And Account System by id
- Get Book Mark Bank And Account System List
- Get Book Mark Bank And Account System by id
- Get My Book Mark Bank And Account System List
- Get My Book Mark Bank And Account System by id
- Update Book Mark Bank And Account System
- Update My Book Mark Bank And Account System
-
_Book Mark Bank And Account(Gen1 Aeena)
- Create new Book Mark Bank And Account
- Create new My Book Mark Bank And Account
- Delete Book Mark Bank And Account by id
- Delete My Book Mark Bank And Account by id
- Get Book Mark Bank And Account List
- Get Book Mark Bank And Account by id
- Get My Book Mark Bank And Account List
- Get My Book Mark Bank And Account by id
- Update Book Mark Bank And Account
- Update My Book Mark Bank And Account
-
_Foo Bar(simonpublic1)
- Create new Foo Bar
- Create new My Foo Bar
- Delete Foo Bar by id
- Delete My Foo Bar by id
- Get Foo Bar List
- Get Foo Bar by id
- Get My Foo Bar List
- Get My Foo Bar by id
- Update Foo Bar
- Update My Foo Bar
-
_Hospital(mommy Map)
- Create new Hospital
- Create new My Hospital
- Delete Hospital by id
- Delete My Hospital by id
- Get Hospital List
- Get Hospital by id
- Get My Hospital List
- Get My Hospital by id
- Update Hospital
- Update My Hospital
-
_Risk Check(tobank)
- Create new My Risk Check
- Create new Risk Check
- Delete My Risk Check by id
- Delete Risk Check by id
- Get My Risk Check List
- Get My Risk Check by id
- Get Risk Check List
- Get Risk Check by id
- Update My Risk Check
- Update Risk Check
-
_Risk Checks(tobank)
- Create new My Risk Checks
- Create new Risk Checks
- Delete My Risk Checks by id
- Delete Risk Checks by id
- Get My Risk Checks List
- Get My Risk Checks by id
- Get Risk Checks List
- Get Risk Checks by id
- Update My Risk Checks
- Update Risk Checks
-
test dynamic
v3.0.0 (240 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 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:
{
"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 the all metrics
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
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
}]
}
-
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.
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:
{
"jsonString":"{}"
}
-
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.