API Explorer
- API
- ATM
-
Account
- Check Available Funds
- Create Account
- Create Account Attribute
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- 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 Checkbook orders
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
- Account Application
- Account Public
- Bank
- Branch
- Card
- Consent
- Consumer
- Counterparty
-
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
- Add Social Media Handle
- Create Address
- Create Credit Limit Order Request
- Create Customer
- Create Tax Residence
- Create User Customer Link
- Delete Customer Address
- Delete Tax Residence
- Get CRM Events
- Get Credit Limit Order Request By Request Id
- Get Credit Limit Order Requests
- Get Customer Addresses
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers for Current User
- Get Customers for current User at Bank
- Get Firehose Customers
- Get Tax Residences of Customer
- 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
- Data Warehouse
- Documentation
- FX
- KYC
- Method Routing
- Metric
- Product
- Product Collection
-
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
- Transaction
- Transaction Metadata
-
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
- Save Historical Transactions
-
User
- Answer Auth Context Update Challenge
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Delete User Auth Context
- Delete User's Auth Contexts
- Get User (Current)
- Get User Auth Contexts
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
- Refresh User
- Unlock the user
- View (Custom)
- View (System)
- WebUi Props
- Webhook
-
API
-
Get API Configuration
-
Get API Info (root)
-
Get Adapter Info
-
Get Adapter Info for a bank
-
Get Connector Status (Loopback)
-
Get JSON Web Key (JWK)
-
Get JSON Web Key (JWK) URIs
-
Get Rate Limiting Info
-
Get API Configuration
-
ATM
-
Account
-
Check Available Funds
-
Create Account
-
Create Account Attribute
-
Get Account by Id (Core)
-
Get Account by Id (Full)
-
Get Accounts Balances
-
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 Checkbook orders
-
Get Firehose Accounts at Bank
-
Update Account
-
Update Account Attribute
-
Update Account Label
-
Check Available Funds
-
Account Application
-
Create Account Application
-
Get Account Application by Id
-
Get Account Applications
-
Update Account Application Status
-
Create Account Application
-
Account Public
-
Bank
-
Branch
-
Card
-
Create Card
-
Create Card Attribute
-
Delete Card
-
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
-
Create Card
-
Consent
-
Consumer
-
Enable or Disable Consumers
-
Get Call Limits for a Consumer
-
Get Consumer
-
Get Consumers
-
Get Consumers (logged in User)
-
Set Calls Limit for a Consumer
-
Update Consumer RedirectUrl
-
Enable or Disable Consumers
-
Counterparty
-
Create Counterparty (Explicit)
-
Get Counterparties (Explicit)
-
Get Counterparty by Counterparty Id (Explicit)
-
Get Other Account by Id
-
Get Other Accounts of one Account
-
Create Counterparty (Explicit)
-
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
-
Add Corporate Location to Counterparty
-
Customer
-
Add Social Media Handle
-
Create Address
-
Create Credit Limit Order Request
-
Create Customer
-
Create Tax Residence
-
Create User Customer Link
-
Delete Customer Address
-
Delete Tax Residence
-
Get CRM Events
-
Get Credit Limit Order Request By Request Id
-
Get Credit Limit Order Requests
-
Get Customer Addresses
-
Get Customer Social Media Handles
-
Get Customer by CUSTOMER_ID
-
Get Customer by CUSTOMER_NUMBER
-
Get Customers for Current User
-
Get Customers for current User at Bank
-
Get Firehose Customers
-
Get Tax Residences of Customer
-
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
-
Add Social Media Handle
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
Get API Glossary
-
Get Message Docs
-
Get Message Docs Swagger
-
Get Resource Docs
-
Get Swagger documentation
-
Get API Glossary
-
FX
-
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
-
Add KYC Check
-
Method Routing
-
Metric
-
Get Aggregate Metrics
-
Get Connector Metrics
-
Get Metrics
-
Get Top APIs
-
Get Top Consumers
-
Search API Metrics via Elasticsearch
-
Get Aggregate Metrics
-
Product
-
Create Product
-
Create Product Attribute
-
Delete Product Attribute
-
Get Bank Product
-
Get Product Attribute
-
Get Product Tree
-
Get Products
-
Update Product Attribute
-
Create Product
-
Product Collection
-
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
-
Add Entitlement for a User
-
Sandbox
-
Scope
-
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)
-
Get Firehose Transactions for Account
-
Transaction Metadata
-
Add a tag
-
Add an image
-
Add comment
-
Add narrative
-
Add where tag
-
Delete a tag
-
Delete an image
-
Delete comment
-
Delete narrative
-
Delete where tag
-
Get comments
-
Get images
-
Get narrative
-
Get tags
-
Get where tag
-
Update narrative
-
Update where tag
-
Add a 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
-
Save Historical Transactions
-
Answer Transaction Request Challenge
-
User
-
Answer Auth Context Update Challenge
-
Create User
-
Create User Auth Context
-
Create User Auth Context Update Request
-
Delete User Auth Context
-
Delete User's Auth Contexts
-
Get User (Current)
-
Get User Auth Contexts
-
Get User Lock Status
-
Get User by USERNAME
-
Get User by USER_ID
-
Get Users by Email Address
-
Get all Users
-
Refresh User
-
Unlock the user
-
Answer Auth Context Update Challenge
-
View (Custom)
-
Create View
-
Delete 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 View
-
Create View
-
View (System)
-
WebUi Props
-
Webhook
v3.1.0 (249 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=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.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=2017-09-19T02:31:05.000Z
2 to_date (defaults to the current date) eg:to_date=2017-09-19T02:31:05.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
- 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=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2
1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z
2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.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=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.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
{
"metrics":[{
"connector_name":"mapper",
"function_name":"getBanks",
"correlation_id":"12345",
"date":"2017-09-19T00:00:00Z",
"duration":1000
}]
}
-
CanGetConnectorMetrics
- Please login to request this Role
- 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=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2
1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z
2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.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=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.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
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
-
user_name: felixsmith
{
"metrics":[{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"url":"www.openbankproject.com",
"date":"2017-09-19T00: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
- 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=2022-11-07T19:23:40.894Z&to_date=2023-11-07T19:23:40.894Z&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=2022-11-07T19:23:40.894Z
2 to_date (defaults to the current date) eg:to_date=2023-11-07T19:23:40.894Z
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
- 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=2022-11-07T19:23:40.895Z&to_date=2023-11-07T19:23:40.895Z&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=2022-11-07T19:23:40.895Z
2 to_date (defaults to the current date) eg:to_date=2023-11-07T19:23:40.895Z
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
- 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:
{
"jsonString":"{}"
}
-
CanSearchMetrics
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.