API Explorer
- API
-
Account
- Create View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
- Account Public
- Bank
- 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
- Documentation
- Transaction
- Transaction Metadata
- View (Custom)
-
API
-
Account
- Create View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
-
Account Public
-
Bank
-
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
-
Documentation
-
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
-
View (Custom)
- Delete View
- 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
v1.2.1 (72 APIs)
Bank
Accounts
Views
Counterparties
Transactions
Add Corporate Location to Counterparty
Add the geolocation of the counterparty's registered address
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow adding a corporate location
- Coordinates not possible
- Corporate Location cannot be deleted
- OBP-50000: Unknown Error.
Add Counterparty More Info
Add a description of the counter party from the perpestive of the account e.g. My dentist
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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-30022: The current view does not have the permission:
- the view ownerdoes not allow adding more info
- More Info cannot be added
- OBP-50000: Unknown Error.
Add Open Corporates URL to Counterparty
Add open corporates url to other bank account
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding an open corporate url
- URL cannot be added
- OBP-50000: Unknown Error.
Add image url to other bank account
Add a url that points to the logo of the counterparty
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow adding an image url
- URL cannot be added
- OBP-50000: Unknown Error.
Add physical location to other bank account
Add geocoordinates of the counterparty's main location
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow adding a physical location
- Coordinates not possible
- Physical Location cannot be added
- OBP-50000: Unknown Error.
Add public alias to other bank account
Creates the public alias for the other account OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is required if the view is not public.
Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if
the public alias was deleted.
The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- the view does not allow metadata access
- the view does not allow adding a public alias
- Alias cannot be added
- public alias added
Add url to other bank account
A url which represents the counterparty (home page url etc.)
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow adding a url
- URL cannot be added
- OBP-50000: Unknown Error.
Create Other Account Private Alias
Creates a private alias for the other account OTHER_ACCOUNT_ID.
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
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a private alias
- Alias cannot be added
- OBP-50000: Unknown Error.
Delete Counterparty Corporate Location
Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- Corporate Location cannot be deleted
- Delete not completed
- OBP-50000: Unknown Error.
Delete Counterparty Image URL
Delete image url of other bank account
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-50000: Unknown Error.
Delete Counterparty Open Corporates URL
Delete open corporate url of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow deleting an open corporate url
- URL cannot be deleted
- OBP-50000: Unknown Error.
Delete Counterparty Physical Location
Delete physical location of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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:
- Physical Location cannot be deleted
- Delete not completed
- OBP-50000: Unknown Error.
Delete Counterparty Private Alias
Deletes the private alias of the other account OTHER_ACCOUNT_ID.
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
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow deleting the private alias
- Alias cannot be deleted
- OBP-50000: Unknown Error.
Delete Counterparty Public Alias
Deletes the public alias of the other account OTHER_ACCOUNT_ID.
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
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow deleting the public alias
- Alias cannot be deleted
- OBP-50000: Unknown Error.
Delete more info of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow deleting more info
- More Info cannot be deleted
- OBP-50000: Unknown Error.
Delete url of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow deleting a url
- URL cannot be deleted
- OBP-50000: Unknown Error.
Get Other Account Metadata
Get metadata of one other account.
Returns only the metadata about one other bank account (OTHER_ACCOUNT_ID) that had shared at least one transaction with ACCOUNT_ID at BANK_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
-
VIEW_ID: owner
JSON response body fields:
{
"public_alias":"NONE",
"private_alias":"NONE",
"more_info":"www.openbankproject.com",
"URL":"www.openbankproject.com",
"image_URL":"www.openbankproject.com",
"open_corporates_URL":"www.openbankproject.com",
"corporate_location":{
"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"
}
},
"physical_location":{
"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-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- the view does not allow metadata access
Get Other Account Private Alias
Returns the private alias of the other account OTHER_ACCOUNT_ID.
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
-
VIEW_ID: owner
JSON response body fields:
{
"alias":"String"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow private alias access
- OBP-50000: Unknown Error.
Get public alias of other bank account
Returns the public alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is Mandatory if the view is not public.
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"alias":"String"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
- the view does not allow metadata access
- the view does not allow public alias access
- OBP-20001: User not logged in. Authentication is required!
Update Counterparty Corporate Location
Update the geolocation of the counterparty's registered address
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow updating a corporate location
- Coordinates not possible
- Corporate Location cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty Image Url
Update the url that points to the logo of the counterparty
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating an image url
- URL cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty More Info
Update the more info description of the counter party from the perpestive of the account e.g. My dentist
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow updating more info
- More Info cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty Physical Location
Update geocoordinates of the counterparty's main location
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow updating a physical location
- Coordinates not possible
- Physical Location cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty Private Alias
Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.
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
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating the private alias
- Alias cannot be updated
- OBP-50000: Unknown Error.
Update Open Corporates Url of Counterparty
Update open corporate url of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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.
- the view does not allow metadata access
- the view does not allow updating an open corporate url
- URL cannot be updated
- OBP-50000: Unknown Error.
Update public alias of other bank account
Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.
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
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating the public alias
- Alias cannot be updated
- OBP-50000: Unknown Error.
Update url of other bank account
A url which represents the counterparty (home page url etc.)
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
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-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- URL cannot be updated
- OBP-50000: Unknown Error.