{"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":"v4.0.0"},"host":"apisandbox.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/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/metadata/tags":{"get":{"tags":["Account-Metadata","Account"],"summary":"Get tags on account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Returns the account ACCOUNT_ID tags made on a view (VIEW_ID).
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
","operationId":"getTagsForViewOnAccount","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account 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/AccountTagsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Account-Metadata","Account"],"summary":"Create a tag on account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Posts a tag about an account ACCOUNT_ID on a view VIEW_ID.
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
","operationId":"addTagForViewOnAccount","parameters":[{"in":"body","name":"body","description":"PostAccountTagJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostAccountTagJSON"}},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/AccountTagJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/metadata/tags/{TAG_ID}":{"delete":{"tags":["Account-Metadata","Account"],"summary":"Delete a tag on account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Deletes the tag TAG_ID about the account ACCOUNT_ID made on view.
Authentication is Mandatory
Authentication is required as the tag is linked with the user.
","operationId":"deleteTagForViewOnAccount","parameters":[{"in":"path","name":"TAG_ID","description":"The tag id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorNoViewPermission"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorNoViewPermission":{"properties":{"message":{"type":"string","example":"OBP-30022: The current view does not have the permission:"}}},"AccountTagsJSON":{"required":["tags"],"properties":{"tags":{"type":"array","items":{"$ref":"#/definitions/AccountTagJSON"}}}},"AccountTagJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"PostAccountTagJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"UserJSONV121":{"required":["id","provider","display_name"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"display_name":{"type":"string","example":"OBP"}}}}}