{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v5.1.0"},"host":"api3.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v5.1.0/banks/{BANK_ID}/meetings":{"get":{"tags":["Customer-Meeting","Customer","Experimental"],"summary":"Get Meetings","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
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
","operationId":"getMeetings","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MeetingsJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Customer-Meeting","Customer","Experimental"],"summary":"Create Meeting (video conference/call)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Meeting: Initiate a video conference/call with the bank.
The Meetings resource contains meta data about video/other conference sessions
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
","operationId":"createMeeting","parameters":[{"in":"body","name":"body","description":"CreateMeetingJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateMeetingJsonV310"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/MeetingJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/meetings/{MEETING_ID}":{"get":{"tags":["Customer-Meeting","Customer","Experimental"],"summary":"Get Meeting","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"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
","operationId":"getMeeting","parameters":[{"in":"path","name":"MEETING_ID","description":"the meeting id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MeetingJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"MeetingsJsonV310":{"required":["meetings"],"properties":{"meetings":{"type":"array","items":{"$ref":"#/definitions/MeetingJsonV310"}}}},"ContactDetailsJson":{"required":["name","mobile_phone","email_address"],"properties":{"name":{"type":"string","example":"Simon "},"mobile_phone":{"type":"string","example":"+44 07972 444 876"},"email_address":{"type":"string","example":"felixsmith@example.com"}}},"MeetingJsonV310":{"required":["present","provider_id","creator","invitees","bank_id","purpose_id","when","meeting_id","keys"],"properties":{"present":{"$ref":"#/definitions/MeetingPresentJson"},"provider_id":{"type":"string","example":"Chris"},"creator":{"$ref":"#/definitions/ContactDetailsJson"},"invitees":{"type":"array","items":{"$ref":"#/definitions/InviteeJson"}},"bank_id":{"type":"string","example":"gh.29.uk"},"purpose_id":{"type":"string","example":"String, eg: onboarding"},"when":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"meeting_id":{"type":"string","example":"UUID-String"},"keys":{"$ref":"#/definitions/MeetingKeysJson"}}},"MeetingKeysJson":{"required":["session_id","staff_token","customer_token"],"properties":{"session_id":{"type":"string","example":"String"},"staff_token":{"type":"string","example":"String"},"customer_token":{"type":"string","example":"String"}}},"MeetingPresentJson":{"required":["staff_user_id","customer_user_id"],"properties":{"staff_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"customer_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"InviteeJson":{"required":["contact_details","status"],"properties":{"contact_details":{"$ref":"#/definitions/ContactDetailsJson"},"status":{"type":"string","example":"String, eg: Good"}}},"CreateMeetingJsonV310":{"required":["provider_id","creator","invitees","date","purpose_id"],"properties":{"provider_id":{"type":"string","example":"Chris"},"creator":{"$ref":"#/definitions/ContactDetailsJson"},"invitees":{"type":"array","items":{"$ref":"#/definitions/InviteeJson"}},"date":{"type":"string","format":"date","example":"1100-01-01T01:01:01Z"},"purpose_id":{"type":"string","example":"String, eg: onboarding"}}}}}