{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2026. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v1.3.0"},"host":"apisandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"Direct Login authentication. POST to /obp/v6.0.0/my/logins/direct with header 'DirectLogin: username=YOUR_USERNAME, password=YOUR_PASSWORD, consumer_key=YOUR_CONSUMER_KEY' to obtain a token. Then use header 'DirectLogin: token=YOUR_TOKEN' on subsequent requests. See the OpenAPI 3.1 spec for full details.","in":"header","name":"DirectLogin"},"gatewayLogin":{"type":"apiKey","description":"Gateway Login authentication. The gateway sends a JWT in the Authorization header signed with a pre-shared secret. See the OpenAPI 3.1 spec for full details.","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/dynamic-endpoint/accounts":{"post":{"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"summary":"Post Accounts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

POST Accounts

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEndpointProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"url_pattern",        "value":"http://obp_mock//accounts"    },    {        "key":"http_method",        "value":"POST"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEndpoint_POST_accounts","parameters":[],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int32","example":"1"}},"required":["name","balance"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-endpoint/accounts/{ACCOUNT_ID}":{"get":{"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"summary":"Get Bank Account By Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Bank Account

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEndpointProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"url_pattern",        "value":"http://obp_mock//accounts/{account_id}"    },    {        "key":"http_method",        "value":"GET"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEndpoint_GET_accounts_ACCOUNT_ID","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int32","example":"1"}},"required":["name","balance"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-endpoint/test-dynamic-resource-doc/my_user/MY_USER_ID":{"post":{"tags":["Dynamic-Resource-Doc"],"summary":"A test endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

A test endpoint.

Just for debug method body of dynamic resource doc.
better watch the following introduction video first
* Dynamic resourceDoc version1

The endpoint return the response from PractiseEndpoint code.
Here, code.api.DynamicEndpoints.dynamic.practise.PractiseEndpoint.process
You can test the method body grammar, and try the business logic, but need to restart the OBP-API code .

User Authentication is Optional. The User need not be logged in.

URL Parameters:

MY_USER_ID: MY_USER_ID

JSON request body fields:

age: 18

hobby: hobby

name: ACCOUNT_MANAGEMENT_FEE

JSON response body fields:

age: 18

hobby: hobby

name: ACCOUNT_MANAGEMENT_FEE

","operationId":"OBPv4.0.0-test-dynamic-resource-doc","parameters":[{"in":"body","name":"body","description":"RequestRootJsonClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/RequestRootJsonClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/RequestRootJsonClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/dynamic-entity/CovidAPIDays":{"get":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Get CovidAPIDays List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get CovidAPIDays List.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /CovidAPIDays?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getCovidAPIDaysList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days_list":{"type":"array","items":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}}},"required":["covid_api_days_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Create new CovidAPIDays","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new CovidAPIDays.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createCovidAPIDays_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/CovidAPIDays/COVID_API_DAYS_ID":{"delete":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Delete CovidAPIDays by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete CovidAPIDays by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteCovidAPIDays_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Get CovidAPIDays by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get CovidAPIDays by id.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleCovidAPIDays_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Update CovidAPIDays","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update CovidAPIDays.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateCovidAPIDays_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/FishPort":{"get":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Get FishPort List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get FishPort List.

Portfolio of fishbased values

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /FishPort?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getFishPortList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"fish_port_list":{"type":"array","items":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}}},"required":["fish_port_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Create new FishPort","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new FishPort.

Portfolio of fishbased values

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createFishPort_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/FishPort/FISH_PORT_ID":{"delete":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Delete FishPort by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete FishPort by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteFishPort_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Get FishPort by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get FishPort by id.

Portfolio of fishbased values

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleFishPort_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Update FishPort","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update FishPort.

Portfolio of fishbased values

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateFishPort_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/FooBar":{"get":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Get FooBar List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get FooBar List.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getFooBarList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"foo_bar_list":{"type":"array","items":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}}},"required":["foo_bar_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Create new FooBar","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new FooBar.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createFooBar_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/FooBar/FOO_BAR_ID":{"delete":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Delete FooBar by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete FooBar by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteFooBar_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Get FooBar by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get FooBar by id.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleFooBar_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Update FooBar","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update FooBar.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateFooBar_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/SimonCovid":{"get":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Get SimonCovid List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get SimonCovid List.

Let's put Covid99 stuff here

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /SimonCovid?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getSimonCovidList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"simon_covid_list":{"type":"array","items":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}}},"required":["simon_covid_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Create new SimonCovid","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new SimonCovid.

Let's put Covid99 stuff here

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createSimonCovid_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/SimonCovid/SIMON_COVID_ID":{"delete":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Delete SimonCovid by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete SimonCovid by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteSimonCovid_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Get SimonCovid by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get SimonCovid by id.

Let's put Covid99 stuff here

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleSimonCovid_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Update SimonCovid","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update SimonCovid.

Let's put Covid99 stuff here

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateSimonCovid_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/D-Entity1":{"get":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get D-Entity1 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get D-Entity1 List.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /D-Entity1?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getD-Entity1List_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1_list":{"type":"array","items":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}}},"required":["bank-id","d-entity1_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new D-Entity1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new D-Entity1.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createD-Entity1_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID":{"delete":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete D-Entity1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete D-Entity1 by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteD-Entity1_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get D-Entity1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get D-Entity1 by id.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleD-Entity1_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update D-Entity1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update D-Entity1.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateD-Entity1_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/InsurancePolicy":{"get":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePolicy List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get InsurancePolicy List.

Which insurance policies the customer already has.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /InsurancePolicy?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getInsurancePolicyList_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy_list":{"type":"array","items":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}}},"required":["bank-id","insurance_policy_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new InsurancePolicy","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new InsurancePolicy.

Which insurance policies the customer already has.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createInsurancePolicy_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/InsurancePolicy/INSURANCE_POLICY_ID":{"delete":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete InsurancePolicy by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete InsurancePolicy by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteInsurancePolicy_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePolicy by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get InsurancePolicy by id.

Which insurance policies the customer already has.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleInsurancePolicy_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update InsurancePolicy","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update InsurancePolicy.

Which insurance policies the customer already has.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateInsurancePolicy_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/InsurancePremium":{"get":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePremium List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get InsurancePremium List.

Retrive the premium for the customer.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /InsurancePremium?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getInsurancePremiumList_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium_list":{"type":"array","items":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}}},"required":["bank-id","insurance_premium_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new InsurancePremium","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new InsurancePremium.

Retrive the premium for the customer.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createInsurancePremium_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/InsurancePremium/INSURANCE_PREMIUM_ID":{"delete":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete InsurancePremium by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete InsurancePremium by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteInsurancePremium_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePremium by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get InsurancePremium by id.

Retrive the premium for the customer.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleInsurancePremium_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update InsurancePremium","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update InsurancePremium.

Retrive the premium for the customer.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateInsurancePremium_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/MarchHare":{"get":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get MarchHare List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get MarchHare List.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /MarchHare?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getMarchHareList_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare_list":{"type":"array","items":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}}},"required":["bank-id","march_hare_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new MarchHare","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new MarchHare.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createMarchHare_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/MarchHare/MARCH_HARE_ID":{"delete":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete MarchHare by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete MarchHare by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteMarchHare_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get MarchHare by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get MarchHare by id.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleMarchHare_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update MarchHare","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update MarchHare.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateMarchHare_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/Odometer":{"get":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Odometer List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Odometer List.

Verify odometer information for flexible contracts.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /Odometer?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getOdometerList_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer_list":{"type":"array","items":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}}},"required":["bank-id","odometer_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new Odometer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new Odometer.

Verify odometer information for flexible contracts.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createOdometer_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/Odometer/ODOMETER_ID":{"delete":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete Odometer by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete Odometer by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteOdometer_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Odometer by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Odometer by id.

Verify odometer information for flexible contracts.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleOdometer_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update Odometer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update Odometer.

Verify odometer information for flexible contracts.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateOdometer_gh.29.uk","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/obp.testing.01/ObpActivity":{"get":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Get ObpActivity List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get ObpActivity List.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /ObpActivity?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getObpActivityList_obp.testing.01","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity_list":{"type":"array","items":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}}},"required":["bank-id","obp_activity_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Create new ObpActivity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new ObpActivity.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createObpActivity_obp.testing.01","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/obp.testing.01/ObpActivity/OBP_ACTIVITY_ID":{"delete":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Delete ObpActivity by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete ObpActivity by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteObpActivity_obp.testing.01","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Get ObpActivity by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get ObpActivity by id.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleObpActivity_obp.testing.01","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Update ObpActivity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update ObpActivity.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateObpActivity_obp.testing.01","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/customer_cars":{"get":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Get customer_cars List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get customer_cars List.

The car the customer arrived in

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /customer_cars?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getcustomer_carsList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"customer_cars_list":{"type":"array","items":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}}},"required":["customer_cars_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Create new customer_cars","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new customer_cars.

The car the customer arrived in

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createcustomer_cars_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_identifier","manufacturer"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/customer_cars/CUSTOMER_CARS_ID":{"delete":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Delete customer_cars by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete customer_cars by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deletecustomer_cars_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_identifier","manufacturer"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Get customer_cars by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get customer_cars by id.

The car the customer arrived in

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSinglecustomer_cars_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Update customer_cars","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update customer_cars.

The car the customer arrived in

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updatecustomer_cars_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_identifier","manufacturer"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/my/test_daniel707":{"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get My test_daniel707 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get My test_daniel707 List.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getMytest_daniel707List_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707_list":{"type":"array","items":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}}},"required":["test_daniel707_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Create new My test_daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new My test_daniel707.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createMytest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/my/test_daniel707/TEST_DANIEL707_ID":{"delete":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Delete My test_daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete My test_daniel707 by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteMytest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get My test_daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get My test_daniel707 by id.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleMytest_daniel707_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Update My test_daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update My test_daniel707.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateMytest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/sustrans":{"get":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Get sustrans List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get sustrans List.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /sustrans?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getsustransList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"sustrans_list":{"type":"array","items":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}}},"required":["sustrans_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Create new sustrans","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new sustrans.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createsustrans_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/sustrans/SUSTRANS_ID":{"delete":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Delete sustrans by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete sustrans by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deletesustrans_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Get sustrans by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get sustrans by id.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSinglesustrans_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Update sustrans","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update sustrans.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updatesustrans_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/test1":{"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get test1 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get test1 List.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /test1?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_gettest1List_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test1_list":{"type":"array","items":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}}},"required":["test1_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Create new test1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new test1.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createtest1_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/test1/TEST1_ID":{"delete":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Delete test1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete test1 by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deletetest1_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get test1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get test1 by id.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingletest1_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Update test1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update test1.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updatetest1_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/test_daniel707":{"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get test_daniel707 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get test_daniel707 List.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_gettest_daniel707List_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707_list":{"type":"array","items":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}}},"required":["test_daniel707_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Create new test_daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new test_daniel707.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createtest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/test_daniel707/TEST_DANIEL707_ID":{"delete":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Delete test_daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete test_daniel707 by id

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deletetest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get test_daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get test_daniel707 by id.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingletest_daniel707_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Update test_daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update test_daniel707.

Description of this entity, can be markdown text.

Property List:

MethodRouting settings example:

{  "is_bank_id_exact_match":false,  "method_name":"dynamicEntityProcess",  "connector_name":"rest_vMar2019",  "bank_id_pattern":".*",  "parameters":[    {        "key":"entityName",        "value":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updatetest_daniel707_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/accounts":{"get":{"tags":["Account","PSD2","Old-Style"],"summary":"Get accounts at all banks (Private, inc views)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of accounts at that the user has access to at all banks.
For each account the API returns the account ID and the available views.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

alias:

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv1.2.1-getPrivateAccountsAllBanks","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/accounts/private":{"get":{"tags":["Account","PSD2","Old-Style"],"summary":"Get private accounts at all banks (Authenticated access)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of private accounts the user has access to at all banks.
For each account the API returns the ID and the available views.

Authentication via OAuth is required.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

alias:

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv1.2.1-privateAccountsAllBanks","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/accounts/public":{"get":{"tags":["Account","Old-Style"],"summary":"Get public accounts at all banks (Anonymous access)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of private accounts the user has access to at all banks.
For each account the API returns the ID and the available views.
Authentication via OAuth is required.

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

alias:

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv1.2.1-publicAccountsAllBanks","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.3.0/banks":{"get":{"tags":["Bank","PSD2","Old-Style"],"summary":"Get Banks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get banks on this API instance
Returns a list of banks supported on this server:

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

address:

bank_routing:

banks:

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

scheme: OBP

short_name:

website: www.openbankproject.com

","operationId":"OBPv1.2.1-getBanks","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BanksJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.3.0/banks/{BANK_ID}":{"get":{"tags":["Bank","PSD2","Old-Style"],"summary":"Get Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the bank specified by BANK_ID
Returns information about a single bank specified by BANK_ID including:

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

address:

bank_routing:

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

scheme: OBP

short_name:

website: www.openbankproject.com

","operationId":"OBPv1.2.1-bankById","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BankJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts":{"get":{"tags":["Account","Old-Style"],"summary":"Get accounts at bank (Private)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of accounts at BANK_ID that the user has access to.
For each account the API returns the account ID and the available views.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv1.2.1-getPrivateAccountsAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/account":{"get":{"tags":["Account","Old-Style"],"summary":"Get account by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):

More details about the data moderation by the view here.

User Authentication is Optional. The User need not be logged in.

Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

account_routing:

address:

alias:

amount: 10.12

balance: 10

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

display_name:

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

number:

owners:

provider: ETHEREUM

scheme: OBP

short_name:

swift_bic:

type:

views_available:

","operationId":"OBPv1.2.1-accountById","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/ModeratedAccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts":{"get":{"tags":["Counterparty","Account","PSD2","Old-Style"],"summary":"Get Other Accounts of one Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.
User Authentication is Optional. The User need not be logged in.
Authentication is required if the view VIEW_ID is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

bank:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

is_alias:

kind:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

national_identifier:

number:

open_corporates_URL:

other_accounts:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

user:

","operationId":"OBPv1.2.1-getOtherAccountsForBankAccount","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/OtherAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}":{"get":{"tags":["Counterparty","Account"],"summary":"Get Other Account by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.
User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

bank:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

is_alias:

kind:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

national_identifier:

number:

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

user:

","operationId":"OBPv1.2.1-getOtherAccountByIdForBankAccount","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata":{"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get Other Account Metadata","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

corporate_location: 10

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

user:

","operationId":"OBPv1.2.1-getOtherAccountMetadata","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountMetadataJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/corporate_location":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Corporate Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyCorporateLocation","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Corporate Location to Counterparty","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add the geolocation of the counterparty's registered address

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

corporate_location: 10

latitude: 38.8951

longitude: -77.0364

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyCorporateLocation","parameters":[{"in":"body","name":"body","description":"CorporateLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CorporateLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Corporate Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update the geolocation of the counterparty's registered address

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyCorporateLocation","parameters":[{"in":"body","name":"body","description":"CorporateLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CorporateLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/image_url":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Image URL","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete image url of other bank account

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyImageUrl","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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/ErrorUnknownError"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add image url to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add a url that points to the logo of the counterparty

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

image_URL:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyImageUrl","parameters":[{"in":"body","name":"body","description":"ImageUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ImageUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Image Url","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update the url that points to the logo of the counterparty

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyImageUrl","parameters":[{"in":"body","name":"body","description":"ImageUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ImageUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/more_info":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete more info of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyMoreInfo","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Counterparty More Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add a description of the counter party from the perpestive of the account e.g. My dentist

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

more_info: More information about this fee

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyMoreInfo","parameters":[{"in":"body","name":"body","description":"MoreInfoJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/MoreInfoJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty More Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update the more info description of the counter party from the perpestive of the account e.g. My dentist

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyMoreInfo","parameters":[{"in":"body","name":"body","description":"MoreInfoJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/MoreInfoJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/open_corporates_url":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Open Corporates URL","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete open corporate url of other bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add Open Corporates URL to Counterparty","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add open corporates url to other bank account

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

open_corporates_URL:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyOpenCorporatesUrl","parameters":[{"in":"body","name":"body","description":"OpenCorporateUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/OpenCorporateUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Open Corporates Url of Counterparty","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update open corporate url of other bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyOpenCorporatesUrl","parameters":[{"in":"body","name":"body","description":"OpenCorporateUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/OpenCorporateUrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/physical_location":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Physical Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete physical location of other bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyPhysicalLocation","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add physical location to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Add geocoordinates of the counterparty's main location

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

latitude: 38.8951

longitude: -77.0364

physical_location:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyPhysicalLocation","parameters":[{"in":"body","name":"body","description":"PhysicalLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PhysicalLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Physical Location","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update geocoordinates of the counterparty's main location

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyPhysicalLocation","parameters":[{"in":"body","name":"body","description":"PhysicalLocationJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PhysicalLocationJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/metadata/url":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete url of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyUrl","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add url to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

A url which represents the counterparty (home page url etc.)

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

URL: http://www.example.com/id-docs/123/image.png

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyUrl","parameters":[{"in":"body","name":"body","description":"UrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update url of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

A url which represents the counterparty (home page url etc.)

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyUrl","parameters":[{"in":"body","name":"body","description":"UrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UrlJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/private_alias":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Private Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the private alias of the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyPrivateAlias","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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/ErrorBankAccountNotFound"}}}},"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get Other Account Private Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the private alias of the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

alias:

","operationId":"OBPv1.2.1-getOtherAccountPrivateAlias","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AliasJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Create Other Account Private Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Creates a private alias for the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

alias:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addOtherAccountPrivateAlias","parameters":[{"in":"body","name":"body","description":"AliasJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AliasJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update Counterparty Private Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyPrivateAlias","parameters":[{"in":"body","name":"body","description":"AliasJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AliasJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/other_accounts/{OTHER_ACCOUNT_ID}/public_alias":{"delete":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Delete Counterparty Public Alias","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the public alias of the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCounterpartyPublicAlias","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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/ErrorBankAccountNotFound"}}}},"get":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Get public alias of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the public alias of the other account OTHER_ACCOUNT_ID.
User Authentication is Optional. The User need not be logged in.
User Authentication is Required. The User must be logged in. The Application must also be authenticated. if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

alias:

","operationId":"OBPv1.2.1-getCounterpartyPublicAlias","parameters":[{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AliasJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Add public alias to other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Creates the public alias for the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
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

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

alias:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addCounterpartyPublicAlias","parameters":[{"in":"body","name":"body","description":"AliasJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AliasJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"put":{"tags":["Counterparty-Metadata","Counterparty"],"summary":"Update public alias of other bank account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateCounterpartyPublicAlias","parameters":[{"in":"body","name":"body","description":"AliasJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AliasJSON"}},{"in":"path","name":"OTHER_ACCOUNT_ID","description":"The other account 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions":{"get":{"tags":["Transaction","Account","PSD2","Old-Style"],"summary":"Get Transactions for Account (Full)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).

Authentication via OAuth is required if the view is not public.

Possible custom url parameters for pagination:

eg1:?limit=100&offset=0

eg2:?limit=100&offset=0&sort_direction=ASC

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

amount: 10.12

bank:

comments:

completed: 2020-01-27

corporate_location: 10

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

display_name:

holder:

holders:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

images:

is_alias:

kind:

label: My Account

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

narrative:

national_identifier:

new_balance: 20

number:

open_corporates_URL:

other_account:

physical_location:

posted: 2020-01-27

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

tags: Create-My-User

this_account:

transactions:

type:

user:

value: 5987953

where:

","operationId":"OBPv1.2.1-getTransactionsForBankAccount","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/TransactionsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/comments":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get Transaction Comments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).

Authentication via OAuth is required if the view is not public.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

comments:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

","operationId":"OBPv1.2.1-getCommentsForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionCommentsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Comment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.

${authenticationRequiredMessage(false)}

Authentication is required since the comment is linked with the user.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

","operationId":"OBPv1.2.1-addCommentForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionCommentJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionCommentJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionCommentJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/comments/{COMMENT_ID}":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Comment","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

COMMENT_ID:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteCommentForViewOnTransaction","parameters":[{"in":"path","name":"COMMENT_ID","description":"The comment id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/images":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get Transaction Images","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

images:

label: My Account

provider: ETHEREUM

user:

","operationId":"OBPv1.2.1-getImagesForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionImagesJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Image","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

The image is linked with the user.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

URL: http://www.example.com/id-docs/123/image.png

label: My Account

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

provider: ETHEREUM

user:

","operationId":"OBPv1.2.1-addImageForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionImageJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionImageJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionImageJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/images/{IMAGE_ID}":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Image","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

IMAGE_ID:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteImageForViewOnTransaction","parameters":[{"in":"path","name":"IMAGE_ID","description":"The image id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/narrative":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the description of the transaction TRANSACTION_ID.

Authentication via OAuth is required if the view is not public.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteTransactionNarrative","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get a Transaction Narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the account owner description of the transaction moderated by the view.

Authentication via OAuth is required if the view is not public.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

narrative:

","operationId":"OBPv1.2.1-getTransactionNarrative","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionNarrativeJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Creates a description of the transaction TRANSACTION_ID.

Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
If you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

narrative:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addTransactionNarrative","parameters":[{"in":"body","name":"body","description":"TransactionNarrativeJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionNarrativeJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}},"put":{"tags":["Transaction-Metadata","Transaction"],"summary":"Update a Transaction Narrative","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Updates the description of the transaction TRANSACTION_ID.

Authentication via OAuth is required if the view is not public.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateTransactionNarrative","parameters":[{"in":"body","name":"body","description":"TransactionNarrativeJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionNarrativeJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/tags":{"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get Transaction Tags","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

","operationId":"OBPv1.2.1-getTagsForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionTagJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Authentication is required as the tag is linked with the user.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

","operationId":"OBPv1.2.1-addTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionTagJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionTagJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionTagJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/tags/{TAG_ID}":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account,
or must be the user that posted the tag.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TAG_ID:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteTagForViewOnTransaction","parameters":[{"in":"path","name":"TAG_ID","description":"The tag id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/metadata/where":{"delete":{"tags":["Transaction-Metadata","Transaction"],"summary":"Delete a Transaction Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the where tag of the transaction TRANSACTION_ID made on view.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

The user must either have owner privileges for this account, or must be the user that posted the geo tag.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteWhereTagForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Transaction-Metadata","Transaction"],"summary":"Get a Transaction where Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
It represents the location where the transaction has been initiated.

Authentication via OAuth is required if the view is not public.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

longitude: -77.0364

provider: ETHEREUM

user:

where:

","operationId":"OBPv1.2.1-getWhereTagForViewOnTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionWhereJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}},"post":{"tags":["Transaction-Metadata","Transaction"],"summary":"Add a Transaction where Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

The geo tag is linked with the user.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

latitude: 38.8951

longitude: -77.0364

where:

JSON response body fields:

success:

","operationId":"OBPv1.2.1-addWhereTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionWhereJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionWhereJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Transaction-Metadata","Transaction"],"summary":"Update a Transaction where Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

The geo tag is linked with the user.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

success:

","operationId":"OBPv1.2.1-updateWhereTagForViewOnTransaction","parameters":[{"in":"body","name":"body","description":"PostTransactionWhereJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionWhereJSON"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/other_account":{"get":{"tags":["Transaction","Counterparty"],"summary":"Get Other Account of Transaction","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get other account of a transaction.
Returns details of the other party involved in the transaction, moderated by the view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

bank:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

is_alias:

kind:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

national_identifier:

number:

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

user:

","operationId":"OBPv1.2.1-getOtherAccountForTransaction","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OtherAccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transactions/{TRANSACTION_ID}/transaction":{"get":{"tags":["Transaction","PSD2","Old-Style"],"summary":"Get Transaction by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

amount: 10.12

bank:

comments:

completed: 2020-01-27

corporate_location: 10

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

display_name:

holder:

holders:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

images:

is_alias:

kind:

label: My Account

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

narrative:

national_identifier:

new_balance: 20

number:

open_corporates_URL:

other_account:

physical_location:

posted: 2020-01-27

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

tags: Create-My-User

this_account:

type:

user:

value: 5987953

where:

","operationId":"OBPv1.2.1-getTransactionByIdForBankAccount","parameters":[{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankAccountNotFound"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions":{"get":{"tags":["View-Custom","Account","Entitlement","Old-Style"],"summary":"Get access","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

display_name:

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

permissions:

provider: ETHEREUM

short_name:

user:

views:

","operationId":"OBPv1.2.1-getPermissionsForBankAccount","parameters":[{"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/PermissionsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions/{PROVIDER}/{PROVIDER_ID}/views":{"delete":{"tags":["View-Custom","Account","User","OwnerViewRequired"],"summary":"Revoke access to all Views on Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

"Revokes access to all Views on an Account for a certain User.

The User is identified by PROVIDER_ID at their PROVIDER.

The Account is specified by BANK_ID and ACCOUNT_ID.

The View is specified by VIEW_ID.

PROVIDER (may be a URL so) must be URL Encoded.

PROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.

Attempting to revoke access to a public view will return an error message.

An Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

PROVIDER: ETHEREUM

PROVIDER_ID:

JSON response body fields:

","operationId":"OBPv1.2.1-removePermissionForUserForBankAccountForAllViews","parameters":[{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider 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/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["View-Custom","Account","User","OwnerViewRequired"],"summary":"Grant User access to a list of views","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Grants the user identified by PROVIDER_ID at their provider PROVIDER access to a list of views at BANK_ID for account ACCOUNT_ID.

All url parameters must be %-encoded, which is often especially relevant for PROVIDER_ID and PROVIDER.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

The User needs to have access to the owner view.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

PROVIDER: ETHEREUM

PROVIDER_ID:

JSON request body fields:

views:

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

views:

","operationId":"OBPv1.2.1-addPermissionForUserForBankAccountForMultipleViews","parameters":[{"in":"body","name":"body","description":"ViewIdsJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ViewIdsJson"}},{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider 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/ViewsJSONV121"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions/{PROVIDER}/{PROVIDER_ID}/views/{VIEW_ID}":{"delete":{"tags":["View-Custom","Account","User","Entitlement","OwnerViewRequired"],"summary":"Revoke access to one View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Revokes access to a View on an Account for a certain User.

The User is identified by PROVIDER_ID at their PROVIDER.

The Account is specified by BANK_ID and ACCOUNT_ID.

The View is specified by VIEW_ID.

PROVIDER (may be a URL so) must be URL Encoded.

PROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.

Attempting to revoke access to a public view will return an error message.

An Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

PROVIDER: ETHEREUM

PROVIDER_ID:

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-removePermissionForUserForBankAccountForOneView","parameters":[{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider 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/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["View-Custom","Account","User","OwnerViewRequired"],"summary":"Grant User access to View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Grants the User identified by PROVIDER_ID at PROVIDER access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.

All url parameters must be %-encoded, which is often especially relevant for PROVIDER and PROVIDER_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

Granting access to a public view will return an error message, as the user already has access.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

PROVIDER: ETHEREUM

PROVIDER_ID:

VIEW_ID: owner

JSON request body fields:

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

","operationId":"OBPv1.2.1-addPermissionForUserForBankAccountForOneView","parameters":[{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider 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":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ViewJSONV121"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions/{PROVIDER_ID}/{USER_ID}":{"get":{"tags":["Account","View-Custom","Entitlement","Old-Style"],"summary":"Get access for specific user","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of the views at BANK_ID for account ACCOUNT_ID that a USER_ID at their provider PROVIDER_ID has access to.
All url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

PROVIDER_ID:

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

views:

","operationId":"OBPv1.2.1-getPermissionForUserForBankAccount","parameters":[{"in":"path","name":"PROVIDER_ID","description":"The provider id","required":true,"type":"string"},{"in":"path","name":"USER_ID","description":"The user 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/ViewsJSONV121"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/views":{"get":{"tags":["View-Custom","Account","Old-Style"],"summary":"Get Views for Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Views

Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.

Views on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.

Data: When a view moderates a set of data, some fields my contain the value null rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.

There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.

Action: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.

Metadata:
Transaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.

The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).

All

Optional

Returns the list of the views created for account ACCOUNT_ID at BANK_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

views:

","operationId":"OBPv1.2.1-getViewsForBankAccount","parameters":[{"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/ViewsJSONV121"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Account","View-Custom","Old-Style"],"summary":"Create View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create a view on bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.
The 'alias' field in the JSON can take one of three values:

The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.

The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true on the view creation, the rest will be set to false.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON request body fields:

allowed_actions:

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

is_public: false

name: ACCOUNT_MANAGEMENT_FEE

which_alias_to_use: public

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

","operationId":"OBPv1.2.1-createViewForBankAccount","parameters":[{"in":"body","name":"body","description":"CreateViewJsonV121 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateViewJsonV121"}},{"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/ViewJSONV121"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/views/{VIEW_ID}":{"delete":{"tags":["View-Custom","Account"],"summary":"Delete Custom View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

","operationId":"OBPv1.2.1-deleteViewForBankAccount","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":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Account","View-Custom","Old-Style"],"summary":"Update View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update an existing view on a bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.

The json sent is the same as during view creation (above), with one difference: the 'name' field
of a view is not editable (it is only set when a view is created)

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

alias:

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

short_name:

","operationId":"OBPv1.2.1-updateViewForBankAccount","parameters":[{"in":"body","name":"body","description":"UpdateViewJsonV121 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UpdateViewJsonV121"}},{"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/ViewJSONV121"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/private":{"get":{"tags":["Account","PSD2","Old-Style"],"summary":"Get private accounts at one bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the list of private accounts at BANK_ID that the user has access to.
For each account the API returns the ID and the available views.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv1.2.1-privateAccountsAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/accounts/public":{"get":{"tags":["Account-Public","Account","PublicData","Old-Style"],"summary":"Get public accounts at one bank (Anonymous access)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns a list of the public accounts at BANK_ID. For each account the API returns the ID and the available views.

Authentication via OAuth is not required.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

description: Description of the object. Maximum length is 2000. It can be any characters here.

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

label: My Account

short_name:

views_available:

","operationId":"OBPv1.2.1-publicAccountsAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/cards":{"get":{"tags":["Card"],"summary":"Get cards for the specified bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account:

alias:

allows: [credit,debit,cash_withdrawal]

bank_card_number: 364435172576215

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

cancelled: false

cards:

collected: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

issue_number: 1

label: My Account

name_on_card: SusanSmith

networks:

on_hot_list: false

pin_reset:

posted: 2020-01-27

reason_requested:

replacement:

requested_date: 2020-01-27

serial_number: 1324234

short_name:

technology: technology1

valid_from_date: 2020-01-27

views_available:

","operationId":"OBPv1.3.0-getCardsForBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PhysicalCardsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/banks/{BANK_ID}/resource-docs/{API_VERSION}/obp":{"get":{"tags":["Documentation","API"],"summary":"Get Bank Level Dynamic Resource Docs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.

You may need some other language resource docs, now we support en_GB and es_ES at the moment.

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

See the Resource Doc endpoint for more information.

Note: Dynamic Resource Docs are cached, TTL is 3600 seconds
Static Resource Docs are cached, TTL is 3600 seconds

Following are more examples:
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

API_VERSION:

BANK_ID: gh.29.uk

JSON response body fields:

","operationId":"OBPv1.4.0-getBankLevelDynamicResourceDocsObp","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.3.0/cards":{"get":{"tags":["Card"],"summary":"Get cards for the current user","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

account:

alias:

allows: [credit,debit,cash_withdrawal]

bank_card_number: 364435172576215

bank_id: gh.29.uk

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

cancelled: false

cards:

collected: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

issue_number: 1

label: My Account

name_on_card: SusanSmith

networks:

on_hot_list: false

pin_reset:

posted: 2020-01-27

reason_requested:

replacement:

requested_date: 2020-01-27

serial_number: 1324234

short_name:

technology: technology1

valid_from_date: 2020-01-27

views_available:

","operationId":"OBPv1.3.0-getCards","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PhysicalCardsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v1.3.0/resource-docs/{API_VERSION}/obp":{"get":{"tags":["Documentation","API"],"summary":"Get Resource Docs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.

You may need some other language resource docs, now we support en_GB and es_ES at the moment.

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

See the Resource Doc endpoint for more information.

Note: Dynamic Resource Docs are cached, TTL is 3600 seconds
Static Resource Docs are cached, TTL is 3600 seconds

Following are more examples:
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

API_VERSION:

JSON response body fields:

","operationId":"OBPv1.4.0-getResourceDocsObpV400","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.3.0/resource-docs/{API_VERSION}/openapi":{"get":{"tags":["Documentation","API"],"summary":"Get OpenAPI 3.1 documentation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns documentation about the RESTful resources on this server in OpenAPI 3.1 format.

API_VERSION is the version you want documentation about e.g. v6.0.0

Query Parameters

You may filter this endpoint using the following optional query parameters:

tags - Filter by endpoint tags (comma-separated list)
• Example: ?tags=Account,Bank or ?tags=Account-Firehose
• All endpoints are given one or more tags which are used for grouping
• Empty values will return error OBP-10053

functions - Filter by function names (comma-separated list)
• Example: ?functions=getBanks,bankById
• Each endpoint is implemented in the OBP Scala code by a 'function'
• Empty values will return error OBP-10054

content - Filter by endpoint type
• Values: static, dynamic, all (case-insensitive)
• static: Only show static/core API endpoints
• dynamic: Only show dynamic/custom endpoints
• all: Show both static and dynamic endpoints (default)
• Invalid values will return error OBP-10052

locale - Language for localized documentation
• Example: ?locale=en_GB or ?locale=es_ES
• Supported locales: en_GB, es_ES, ro_RO
• Invalid locales will return error OBP-10041

api-collection-id - Filter by API collection UUID
• Example: ?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
• Returns only endpoints belonging to the specified collection
• Empty values will return error OBP-10055

This endpoint generates OpenAPI 3.1 compliant documentation with modern JSON Schema support.

For YAML format, use the corresponding endpoint: /resource-docs/API_VERSION/openapi.yaml

See the Resource Doc endpoint for more information.

Note: Resource Docs are cached, TTL is 3600 seconds

Examples

Basic usage:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi

Filter by tags:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account-Firehose

Filter by content type:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=dynamic

Filter by functions:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?functions=getBanks,bankById

Combine multiple parameters:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&tags=Account-Firehose
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank,PSD2&functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&locale=en_GB&tags=Account

Filter by API collection:
https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221

User Authentication is Optional. The User need not be logged in.

URL Parameters:

API_VERSION:

JSON response body fields:

","operationId":"OBPv1.4.0-getResourceDocsOpenAPI31","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidApiVersionString"}}}}},"/obp/v1.3.0/resource-docs/{API_VERSION}/swagger":{"get":{"tags":["Documentation","API"],"summary":"Get Swagger documentation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns documentation about the RESTful resources on this server in Swagger format.

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank

(All endpoints are given one or more tags which for used in grouping)

You may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById

(Each endpoint is implemented in the OBP Scala code by a 'function')

See the Resource Doc endpoint for more information.

Note: Resource Docs are cached, TTL is 3600 seconds

Following are more examples:
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById

User Authentication is Optional. The User need not be logged in.

URL Parameters:

API_VERSION:

JSON response body fields:

","operationId":"OBPv1.4.0-getResourceDocsSwagger","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.3.0/root":{"get":{"tags":["API"],"summary":"Get API Info (root)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns information about:

User Authentication is Optional. The User need not be logged in.

JSON response body fields:

connector: connector

email: felixsmith@example.com

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

hosted_by:

organisation:

organisation_website:

phone:

version:

version_status:

","operationId":"OBPv1.3.0-root","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/APIInfoJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}}},"definitions":{"ErrorInvalidJsonFormat":{"properties":{"message":{"type":"string","example":"OBP-10001: Incorrect json format."}}},"ErrorInvalidApiVersionString":{"properties":{"message":{"type":"string","example":"OBP-00027: Invalid API Version string. We could not find the version specified."}}},"ErrorAuthenticatedUserIsRequired":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorBankAccountNotFound":{"properties":{"message":{"type":"string","example":"OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. "}}},"ErrorNoViewPermission":{"properties":{"message":{"type":"string","example":"OBP-30022: The current view does not have the permission:"}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"RequestRootJsonClass":{"required":["name","age","hobby"],"properties":{"name":{"type":"string","example":"ACCOUNT_MANAGEMENT_FEE"},"age":{"type":"integer","format":"int64","example":"18"},"hobby":{"type":"array","items":{"type":"string"}}}},"AliasJSON":{"required":["alias"],"properties":{"alias":{"type":"string","example":"String"}}},"OpenCorporateUrlJSON":{"required":["open_corporates_URL"],"properties":{"open_corporates_URL":{"type":"string","example":"String"}}},"PostTransactionWhereJSON":{"required":["where"],"properties":{"where":{"$ref":"#/definitions/LocationPlainJSON"}}},"PostTransactionImageJSON":{"required":["label","URL"],"properties":{"label":{"type":"string","example":"String"},"URL":{"type":"string","example":"String"}}},"PostTransactionCommentJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"MoreInfoJSON":{"required":["more_info"],"properties":{"more_info":{"type":"string","example":"String"}}},"ImageUrlJSON":{"required":["image_URL"],"properties":{"image_URL":{"type":"string","example":"String"}}},"TransactionNarrativeJSON":{"required":["narrative"],"properties":{"narrative":{"type":"string","example":"narative"}}},"UpdateViewJsonV121":{"required":["description","is_public","hide_metadata_if_alias_used","which_alias_to_use","allowed_actions"],"properties":{"description":{"type":"string","example":"This view is for family"},"is_public":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"false"},"which_alias_to_use":{"type":"string","example":"family"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"PostTransactionTagJSON":{"required":["value"],"properties":{"value":{"type":"string","example":"String"}}},"ViewIdsJson":{"required":["views"],"properties":{"views":{"type":"array","items":{"type":"string"}}}},"UrlJSON":{"required":["URL"],"properties":{"URL":{"type":"string","example":"String"}}},"CorporateLocationJSON":{"required":["corporate_location"],"properties":{"corporate_location":{"$ref":"#/definitions/LocationPlainJSON"}}},"PhysicalLocationJSON":{"required":["physical_location"],"properties":{"physical_location":{"$ref":"#/definitions/LocationPlainJSON"}}},"CreateViewJsonV121":{"required":["name","description","is_public","hide_metadata_if_alias_used","which_alias_to_use","allowed_actions"],"properties":{"name":{"type":"string","example":"_test"},"description":{"type":"string","example":"This view is for family"},"is_public":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"false"},"which_alias_to_use":{"type":"string","example":"family"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"AccountJSON":{"required":["id","label","views_available","bank_id"],"properties":{"id":{"type":"string","example":"123"},"label":{"type":"string","example":"OBP"},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}},"bank_id":{"type":"string","example":"gh.29.uk"}}},"ViewsJSONV121":{"required":["views"],"properties":{"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}}}},"SuccessMessage":{"required":["success"],"properties":{"success":{"type":"string","example":"Success"}}},"TransactionImagesJSON":{"required":["images"],"properties":{"images":{"type":"array","items":{"$ref":"#/definitions/TransactionImageJSON"}}}},"TransactionWhereJSON":{"required":["where"],"properties":{"where":{"$ref":"#/definitions/LocationJSONV121"}}},"PhysicalCardsJSON":{"required":["cards"],"properties":{"cards":{"type":"array","items":{"$ref":"#/definitions/PhysicalCardJSON"}}}},"TransactionImageJSON":{"required":["URL","label","id","date","user"],"properties":{"URL":{"type":"string","example":"www.openbankproject.com"},"label":{"type":"string","example":"NONE"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"TransactionCommentJSON":{"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"}}},"OtherAccountsJSON":{"required":["other_accounts"],"properties":{"other_accounts":{"type":"array","items":{"$ref":"#/definitions/OtherAccountJSON"}}}},"OtherAccountJSON":{"required":["number","IBAN","swift_bic","holder","bank","id","metadata","kind"],"properties":{"number":{"type":"string","example":"123"},"IBAN":{"type":"string","example":"UK234DB"},"swift_bic":{"type":"string","example":"UK12321DB"},"holder":{"$ref":"#/definitions/AccountHolderJSON"},"bank":{"$ref":"#/definitions/MinimalBankJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"metadata":{"$ref":"#/definitions/OtherAccountMetadataJSON"},"kind":{"type":"string","example":"3456"}}},"OtherAccountMetadataJSON":{"required":["public_alias","image_URL","physical_location","private_alias","URL","more_info","corporate_location","open_corporates_URL"],"properties":{"public_alias":{"type":"string","example":"NONE"},"image_URL":{"type":"string","example":"www.openbankproject.com"},"physical_location":{"$ref":"#/definitions/LocationJSONV121"},"private_alias":{"type":"string","example":"NONE"},"URL":{"type":"string","example":"www.openbankproject.com"},"more_info":{"type":"string","example":"www.openbankproject.com"},"corporate_location":{"$ref":"#/definitions/LocationJSONV121"},"open_corporates_URL":{"type":"string","example":"www.openbankproject.com"}}},"PermissionsJSON":{"required":["permissions"],"properties":{"permissions":{"type":"array","items":{"$ref":"#/definitions/PermissionJSON"}}}},"ViewJSONV121":{"required":["can_see_transaction_start_date","can_add_url","can_add_where_tag","can_see_transaction_this_bank_account","can_see_bank_account_owners","can_see_private_alias","can_edit_owner_comment","can_see_other_account_national_identifier","can_see_public_alias","can_see_physical_location","can_see_owner_comment","can_see_bank_account_iban","can_see_corporate_location","can_see_bank_account_number","can_see_other_account_bank_name","description","can_see_transaction_other_bank_account","can_delete_corporate_location","can_see_comments","can_see_bank_account_bank_name","can_add_more_info","can_see_other_account_number","can_see_other_account_swift_bic","can_add_open_corporates_url","can_see_other_account_kind","can_delete_physical_location","can_see_bank_account_label","can_see_transaction_currency","is_public","can_see_transaction_finish_date","can_add_tag","can_see_images","can_see_bank_account_currency","hide_metadata_if_alias_used","can_delete_where_tag","alias","can_add_image_url","can_add_comment","can_see_image_url","id","can_see_bank_account_national_identifier","can_see_tags","can_see_open_corporates_url","short_name","can_delete_tag","can_see_more_info","can_see_transaction_metadata","can_delete_comment","can_see_where_tag","can_add_private_alias","can_add_public_alias","can_see_bank_account_swift_bic","can_add_image","can_see_transaction_type","can_see_other_account_iban","can_add_physical_location","can_add_corporate_location","can_delete_image","can_see_url","can_see_bank_account_balance","can_see_transaction_balance","can_see_transaction_amount","can_see_other_account_metadata","can_see_bank_account_type","can_see_transaction_description"],"properties":{"can_see_transaction_start_date":{"type":"boolean","example":"true"},"can_add_url":{"type":"boolean","example":"true"},"can_add_where_tag":{"type":"boolean","example":"true"},"can_see_transaction_this_bank_account":{"type":"boolean","example":"true"},"can_see_bank_account_owners":{"type":"boolean","example":"true"},"can_see_private_alias":{"type":"boolean","example":"true"},"can_edit_owner_comment":{"type":"boolean","example":"true"},"can_see_other_account_national_identifier":{"type":"boolean","example":"true"},"can_see_public_alias":{"type":"boolean","example":"true"},"can_see_physical_location":{"type":"boolean","example":"true"},"can_see_owner_comment":{"type":"boolean","example":"true"},"can_see_bank_account_iban":{"type":"boolean","example":"true"},"can_see_corporate_location":{"type":"boolean","example":"true"},"can_see_bank_account_number":{"type":"boolean","example":"true"},"can_see_other_account_bank_name":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"can_see_transaction_other_bank_account":{"type":"boolean","example":"true"},"can_delete_corporate_location":{"type":"boolean","example":"true"},"can_see_comments":{"type":"boolean","example":"true"},"can_see_bank_account_bank_name":{"type":"boolean","example":"true"},"can_add_more_info":{"type":"boolean","example":"true"},"can_see_other_account_number":{"type":"boolean","example":"true"},"can_see_other_account_swift_bic":{"type":"boolean","example":"true"},"can_add_open_corporates_url":{"type":"boolean","example":"true"},"can_see_other_account_kind":{"type":"boolean","example":"true"},"can_delete_physical_location":{"type":"boolean","example":"true"},"can_see_bank_account_label":{"type":"boolean","example":"true"},"can_see_transaction_currency":{"type":"boolean","example":"true"},"is_public":{"type":"boolean","example":"true"},"can_see_transaction_finish_date":{"type":"boolean","example":"true"},"can_add_tag":{"type":"boolean","example":"true"},"can_see_images":{"type":"boolean","example":"true"},"can_see_bank_account_currency":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"true"},"can_delete_where_tag":{"type":"boolean","example":"true"},"alias":{"type":"string","example":"None"},"can_add_image_url":{"type":"boolean","example":"true"},"can_add_comment":{"type":"boolean","example":"true"},"can_see_image_url":{"type":"boolean","example":"true"},"id":{"type":"string","example":"123"},"can_see_bank_account_national_identifier":{"type":"boolean","example":"true"},"can_see_tags":{"type":"boolean","example":"true"},"can_see_open_corporates_url":{"type":"boolean","example":"true"},"short_name":{"type":"string","example":"short_name"},"can_delete_tag":{"type":"boolean","example":"true"},"can_see_more_info":{"type":"boolean","example":"true"},"can_see_transaction_metadata":{"type":"boolean","example":"true"},"can_delete_comment":{"type":"boolean","example":"true"},"can_see_where_tag":{"type":"boolean","example":"true"},"can_add_private_alias":{"type":"boolean","example":"true"},"can_add_public_alias":{"type":"boolean","example":"true"},"can_see_bank_account_swift_bic":{"type":"boolean","example":"true"},"can_add_image":{"type":"boolean","example":"true"},"can_see_transaction_type":{"type":"boolean","example":"true"},"can_see_other_account_iban":{"type":"boolean","example":"true"},"can_add_physical_location":{"type":"boolean","example":"true"},"can_add_corporate_location":{"type":"boolean","example":"true"},"can_delete_image":{"type":"boolean","example":"true"},"can_see_url":{"type":"boolean","example":"true"},"can_see_bank_account_balance":{"type":"boolean","example":"true"},"can_see_transaction_balance":{"type":"boolean","example":"true"},"can_see_transaction_amount":{"type":"boolean","example":"true"},"can_see_other_account_metadata":{"type":"boolean","example":"true"},"can_see_bank_account_type":{"type":"boolean","example":"true"},"can_see_transaction_description":{"type":"boolean","example":"true"}}},"TransactionTagJSON":{"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"}}},"APIInfoJSON":{"required":["version_status","version","connector","hosted_by","git_commit"],"properties":{"version_status":{"type":"string","example":"String"},"version":{"type":"string","example":"String"},"connector":{"type":"string","example":"String"},"hosted_by":{"$ref":"#/definitions/HostedBy"},"git_commit":{"type":"string","example":"String"}}},"TransactionsJSON":{"required":["transactions"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/definitions/TransactionJSON"}}}},"TransactionJSON":{"required":["this_account","id","details","metadata","other_account"],"properties":{"this_account":{"$ref":"#/definitions/ThisAccountJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"details":{"$ref":"#/definitions/TransactionDetailsJSON"},"metadata":{"$ref":"#/definitions/TransactionMetadataJSON"},"other_account":{"$ref":"#/definitions/OtherAccountJSON"}}},"TransactionCommentsJSON":{"required":["comments"],"properties":{"comments":{"type":"array","items":{"$ref":"#/definitions/TransactionCommentJSON"}}}},"BankJSON":{"required":["website","full_name","logo","id","short_name","bank_routing"],"properties":{"website":{"type":"string","example":"www.openbankproject.com"},"full_name":{"type":"string","example":"full_name"},"logo":{"type":"string","example":"logo"},"id":{"type":"string","example":"gh.29.uk"},"short_name":{"type":"string","example":"short_name "},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"}}},"BanksJSON":{"required":["banks"],"properties":{"banks":{"type":"array","items":{"$ref":"#/definitions/BankJSON"}}}},"ModeratedAccountJSON":{"required":["number","account_routing","views_available","IBAN","label","owners","swift_bic","balance","bank_id","id","type"],"properties":{"number":{"type":"string","example":"123"},"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"},"views_available":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}},"IBAN":{"type":"string","example":"DE89 3704 0044 0532 0130 00"},"label":{"type":"string","example":"NoneLabel"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"swift_bic":{"type":"string","example":"OKOYFIHH"},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"type":{"type":"string","example":"OBP"}}},"LocationPlainJSON":{"required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":"1.532"},"longitude":{"type":"number","format":"double","example":"1.535"}}},"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"}}},"LocationJSONV121":{"required":["latitude","longitude","date","user"],"properties":{"latitude":{"type":"number","format":"double","example":"1.231"},"longitude":{"type":"number","format":"double","example":"1.231"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"ReplacementJSON":{"required":["requested_date","reason_requested"],"properties":{"requested_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"reason_requested":{"type":"string","example":"RENEW"}}},"PinResetJSON":{"required":["requested_date","reason_requested"],"properties":{"requested_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"reason_requested":{"type":"string","example":"FORGOT"}}},"PhysicalCardJSON":{"required":["allows","expires_date","networks","issue_number","replacement","enabled","collected","technology","cancelled","bank_id","pin_reset","serial_number","account","valid_from_date","bank_card_number","name_on_card","posted","on_hot_list"],"properties":{"allows":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"networks":{"type":"array","items":{"type":"string"}},"issue_number":{"type":"string","example":"1"},"replacement":{"$ref":"#/definitions/ReplacementJSON"},"enabled":{"type":"boolean","example":"true"},"collected":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"technology":{"type":"string","example":"String"},"cancelled":{"type":"boolean","example":"true"},"bank_id":{"type":"string","example":"gh.29.uk"},"pin_reset":{"type":"array","items":{"$ref":"#/definitions/PinResetJSON"}},"serial_number":{"type":"string","example":"1324234"},"account":{"$ref":"#/definitions/AccountJSON"},"valid_from_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"bank_card_number":{"type":"string","example":"364435172576215"},"name_on_card":{"type":"string","example":"String"},"posted":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"on_hot_list":{"type":"boolean","example":"true"}}},"AccountHolderJSON":{"required":["name","is_alias"],"properties":{"name":{"type":"string","example":"OBP"},"is_alias":{"type":"boolean","example":"true"}}},"MinimalBankJSON":{"required":["national_identifier","name"],"properties":{"national_identifier":{"type":"string","example":"OBP"},"name":{"type":"string","example":"OBP"}}},"PermissionJSON":{"required":["user","views"],"properties":{"user":{"$ref":"#/definitions/UserJSONV121"},"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}}}},"HostedBy":{"required":["organisation","email","phone","organisation_website"],"properties":{"organisation":{"type":"string","example":"String"},"email":{"type":"string","example":"String"},"phone":{"type":"string","example":"String"},"organisation_website":{"type":"string","example":"String"}}},"ThisAccountJSON":{"required":["number","IBAN","swift_bic","bank","id","holders","kind"],"properties":{"number":{"type":"string","example":"123"},"IBAN":{"type":"string","example":"UK1234AD"},"swift_bic":{"type":"string","example":"UK1234AD"},"bank":{"$ref":"#/definitions/MinimalBankJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"holders":{"type":"array","items":{"$ref":"#/definitions/AccountHolderJSON"}},"kind":{"type":"string","example":"AC"}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"TransactionDetailsJSON":{"required":["new_balance","description","completed","type","value","posted"],"properties":{"new_balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"this is for family"},"completed":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"type":{"type":"string","example":"AC"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"TransactionMetadataJSON":{"required":["narrative","tags","where","images","comments"],"properties":{"narrative":{"type":"string","example":"NONE"},"tags":{"type":"array","items":{"$ref":"#/definitions/TransactionTagJSON"}},"where":{"$ref":"#/definitions/LocationJSONV121"},"images":{"type":"array","items":{"$ref":"#/definitions/TransactionImageJSON"}},"comments":{"type":"array","items":{"$ref":"#/definitions/TransactionCommentJSON"}}}},"BankRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"gh.29.uk"}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}}}}