API Explorer
- API
- ATM
- Account
- Account Public
- Bank
- Branch
- Card
- 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
- Customer Meeting
- Customer Message
- Data Warehouse
- Documentation
- FX
- KYC
- 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
- Transaction
- Transaction Metadata
- Transaction Request
- User
- View (Custom)
-
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
- Add Social Media Handle
- Create Customer
- 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 Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
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
-
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
-
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 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
-
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 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
v3.0.0 (164 APIs)
Bank
Accounts
Views
Counterparties
Transactions
Create Meeting (video conference/call)
Create Meeting: Initiate a video conference/call with the bank.
The Meetings resource contains meta data about video/other conference sessions, not the video/audio/chat itself.
The actual conferencing is handled by external providers. Currently OBP supports tokbox video conferences (WIP).
This is not a recomendation of tokbox per se.
provider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).
purpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).
Login is required.
This call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON request body fields:
JSON response body fields:
-
bank_id: gh.29.uk
-
session_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
-
when: 2020-01-27
{
"meeting_id":"String",
"provider_id":"Chris",
"purpose_id":"String",
"bank_id":"gh.29.uk",
"present":{
"staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
},
"keys":{
"session_id":"String",
"staff_token":"String",
"customer_token":"String"
},
"when":"2017-09-19T00:00:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30102: Meeting provider API Key is not configured.
- OBP-30103: Meeting provider Secret is not configured.
- OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-30101: Meetings are not supported on this server.
- OBP-50000: Unknown Error.
Get Meeting
Get Meeting specified by BANK_ID / MEETING_ID
Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
Login is required.
This call is experimental and will require further authorisation in the future.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
bank_id: gh.29.uk
-
session_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
-
when: 2020-01-27
{
"meeting_id":"String",
"provider_id":"Chris",
"purpose_id":"String",
"bank_id":"gh.29.uk",
"present":{
"staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
},
"keys":{
"session_id":"String",
"staff_token":"String",
"customer_token":"String"
},
"when":"2017-09-19T00:00:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30102: Meeting provider API Key is not configured.
- OBP-30103: Meeting provider Secret is not configured.
- OBP-30104: Meeting not found.
- OBP-30101: Meetings are not supported on this server.
- OBP-50000: Unknown Error.
Get Meetings
Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
Login is required.
This call is experimental and will require further authorisation in the future.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
bank_id: gh.29.uk
-
session_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
-
when: 2020-01-27
{
"meetings":[{
"meeting_id":"String",
"provider_id":"Chris",
"purpose_id":"String",
"bank_id":"gh.29.uk",
"present":{
"staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
},
"keys":{
"session_id":"String",
"staff_token":"String",
"customer_token":"String"
},
"when":"2017-09-19T00:00:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30102: Meeting provider API Key is not configured.
- OBP-30103: Meeting provider Secret is not configured.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30101: Meetings are not supported on this server.
- OBP-50000: Unknown Error.