API Explorer

v2.0.0 (115 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:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "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" }
Possible Errors:
  • 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.
Connector Methods:
Implemented in OBPv2.0.0 by createMeeting, operation_id: OBPv2.0.0-createMeeting

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:

JSON response body fields:

Typical Successful Response:

								
									
{ "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" }
Possible Errors:
  • 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.
Connector Methods:
Implemented in OBPv2.0.0 by getMeeting, operation_id: OBPv2.0.0-getMeeting

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:

JSON response body fields:

Typical Successful Response:

								
									
{ "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" }] }
Possible Errors:
  • 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.
Connector Methods:
Implemented in OBPv2.0.0 by getMeetings, operation_id: OBPv2.0.0-getMeetings