API Explorer
- API
- Account
- Account Public
- Bank
- Branch
- Card
- 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
- Customer Meeting
- Customer Message
- Data Warehouse
- Documentation
- KYC
- Metric
- Person
- Role
- Transaction
- Transaction Metadata
- Transaction Request
- User
- View (Custom)
-
API
-
Account
-
Create Account
-
Create View
-
Get Account by Id (Core)
-
Get Account by Id (Full)
-
Get Accounts at Bank
-
Get Accounts at Bank (Private)
-
Get Accounts at all Banks (Private)
-
Get all Accounts at all Banks
-
Get private accounts at one bank
-
Update Account Label
-
Update View
-
Create Account
-
Account Public
-
Bank
-
Branch
-
Card
-
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
-
Add Corporate Location to Counterparty
-
Customer
-
Add Social Media Handle
-
Create Customer
-
Create User Customer Link
-
Get CRM Events
-
Get Customer Social Media Handles
-
Get customer for logged in user
-
Add Social Media Handle
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
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
-
Metric
-
Person
-
Role
-
Transaction
-
Get Other Account of Transaction
-
Get Transaction by Id
-
Get Transactions for Account (Core)
-
Get Transactions for Account (Full)
-
Get Other Account of Transaction
-
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
-
Get Transaction Request Types for Account
-
Get Transaction Requests
-
Answer Transaction Request Challenge
-
User
-
View (Custom)
-
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
-
Delete View
v2.0.0 (115 APIs)
Add a tag
Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
- value: 5987953
JSON response body fields:
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Add an image
Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.
Authentication is Mandatory
The image is linked with the user.
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
-
label: My Account
JSON response body fields:
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NONE",
"URL":"www.openbankproject.com",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
- OBP-10001: Incorrect json format.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-10017: Incorrect URL Format.
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
Add comment
Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.
${authenticationRequiredMessage(false)}
Authentication is required since the comment is linked with the user.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
- value: 5987953
JSON response body fields:
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Add narrative
Creates a description of the transaction TRANSACTION_ID.
Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
If you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).
Authentication is Optional
Authentication is required if the view is not public.
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- OBP-10001: Incorrect json format.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Add where tag
Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.
Authentication is Mandatory
The geo tag is linked with the user.
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-30022: The current view does not have the permission:
- Coordinates not possible
- OBP-50000: Unknown Error.
Delete a tag
Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account,
or must be the user that posted the tag.
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Delete an image
Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-20001: User not logged in. Authentication is required!
- You must be able to see images in order to delete them
- Image not found for this transaction
- Deleting images not permitted for this view
- Deleting images not permitted for the current user
- OBP-50000: Unknown Error.
Delete comment
Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Delete narrative
Deletes the description of the transaction TRANSACTION_ID.
Authentication via OAuth is required if the view is not public.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-50000: Unknown Error.
Delete where tag
Deletes the where tag of the transaction TRANSACTION_ID made on view.
Authentication is Mandatory
The user must either have owner privileges for this account, or must be the user that posted the geo tag.
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-20001: User not logged in. Authentication is required!
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- there is no tag to delete
- Delete not completed
- OBP-50000: Unknown Error.
Get comments
Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"comments":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Get images
Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"images":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NONE",
"URL":"www.openbankproject.com",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Get narrative
Returns the account owner description of the transaction moderated by the view.
Authentication via OAuth is required if the view is not public.
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"narrative":"narative"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Get tags
Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Get where tag
Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
It represents the location where the transaction has been initiated.
Authentication via OAuth is required if the view is not public.
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"where":{
"latitude":1.231,
"longitude":1.231,
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Update narrative
Updates the description of the transaction TRANSACTION_ID.
Authentication via OAuth is required if the view is not public.
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- OBP-10001: Incorrect json format.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-50000: Unknown Error.
Update where tag
Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.
Authentication is Mandatory
The geo tag is linked with the user.
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- OBP-30022: The current view does not have the permission:
- Coordinates not possible
- OBP-50000: Unknown Error.